Skip to content

Installation

R3tuxn edited this page Sep 4, 2021 · 14 revisions

Before we begin - Requirements

You will need to have the following things for the Plot System to work:

  • at least 1 Terra121 / Terra++ Minecraft Server
  • 1 Vanilla Spigot Minecraft Server - this is where the Plot System will run
  • 1 MariaDB (MySQL) Database

Setting up the Plot System Server

On your Vanilla Spigot server (which can also just be a regular HUB), you first of all install the latest version of the Plot System, which can be found here.

For the Plot System to properly run however, you will first need to install the following dependencies first by downloading and moving them into the plugins folder:

If any of the dependencies are missing, an error like this will appear in the console:

[00:27:58 INFO]: ------------------ Plot-System V2.0 ------------------
[00:27:58 INFO]: Starting plugin...
[00:27:58 INFO]:
[00:27:58 INFO]: [X] Could not load required dependencies.
[00:27:58 INFO]: Missing Dependencies:
[00:27:58 INFO]:  - Multiverse-Core (V2.5.0)
[00:27:58 INFO]:  - WorldEdit (V6.1.9)
[00:27:58 INFO]:  - WorldGuard (V6.2.2)
[00:27:58 INFO]:  - FastAsyncWorldEdit (FAWE)
[00:27:58 INFO]:  - HeadDatabase
[00:27:58 INFO]:  - VoidGen (V2.0)
[00:27:58 INFO]:
[00:27:58 INFO]: Disabling plugin...
[00:27:58 INFO]: ------------------------------------------------------

Configurations

Next, the config must be configured!

Simply enter your URL and database credentials into the config.

database:
  url: jdbc:mariadb://adress:3306/
  dbname: plotsystem
  username: plotsystem
  password: minecraft

If you want to create a new SQL user for the plot system or want to use an existing one, make sure it has the following permissions:

SELECT, INSERT, UPDATE, DELETE, CREATE

or use command:

GRANT SELECT, INSERT, UPDATE, DELETE, CREATE ON plotsystem.* TO plotsystem@% WITH GRANT OPTION

which will grant all requiered permissions to the plotsystem user and the database with the name plotsystem.\ Otherwise feel free to just use an already existing user or the root user!

The database will then be automatically created with the name you entered on the dbname field, if it doesn't exist already!

It is recommended, that you go through the configuration wiki page and make sure that all the other smaller settings are correct as well.

Setup Commands

Finally, you should be able to start the Plot System server without any issues!

Join the server and enter the following commands as an operator or with the plotsystem.admin.pss.* permission.

FTP Configurations

You can either use FTP/SFTP to communicate between your Terra and your Plot server or not use FTP Configurations, in which case it will just place the schematics directly into the given directory locally, where you can then transfer them with the use of symbolic links or your own method (ideal if both servers are on the same VPS).

if you do decide to use FTP, you will have to create an FTP configuration using:

/pss ftp add <Address> <Port> <Username> <Password>

Then set the path using:

/pss ftp setpath

Servers

Now we finally come to the individual Terra Servers.

Make sure each one of them has the Plot System Terra plugin installed and is configured correctly (you can find a wiki article about that here).

For each Terra server that you use, enter the following command:

/pss server add <Name>

The field name should be the same as configured on the Terra server. We recommend to use the same names as the ones in the Bungeecord config for simplicity.

If you are using FTP, you also have to add your FTP Configuration to the server with the following command:

/pss server setftp <Server-ID> <FTP-ID/None>

To get the Server ID of a previously created Server, enter /pss server list, likewise use /pss ftp list to get the FTP IDs!

Country

Regardless if you are hosting a range of Countries or Canton/States/Regions, you should create a separate "Country" entry for each one of them.

You need to have at least one Country set up, to create City Projects in it.

To create a country enter the following:

/pss country add <Server-ID> <Name>

Furthermore, each Country has its own custom Head, which will be displayed in the Companion UI. To add or change the Head Database ID of that head, use this command:

/pss country sethead <Country-ID> <Head-ID>

City Projects

City Projects are the individual Cities/Towns/Places, that you want to create Plots for.

Create them like the following:

/pss city add <Country-ID> <Name>

Set the description:

/pss city setdescription <City-ID> <Description>

And last but not least, set the visibility:

/pss city setvisible <City-ID> <True/False>
Clone this wiki locally