Repository navigation
Installation
You will need:
- at least 1 Terra+- Minecraft Server
- 1 separate Paper Minecraft Server — this is where the Plot System will run
- at least 1, ideally 2 MariaDB or MySQL Databases — one for Plot System, one for LangLibs
| Plot System | Paper (plot server) | LangLibs | Notes |
|---|---|---|---|
| v5.0.x – v5.1.2 | 1.21.x | 1.5+ | Multiverse 5+, FancyNpcs 2.4.3+ |
| v5.2.x | 26.1+ | 1.6+ | World-gen rework; HeadDB optional |
| v5.3.0+ | 26.1+ | 1.6+ |
Recommended — integration API, claim limits, /plotmaintenance, reviewer QoL |
Always use matching Plot-System-Terra for your Plot System major version.
We will firstly set up the server where the main Plot System plugin will run. This is where users build plots. It should run vanilla Paper.
Warning
The Plot System server can also just be a regular Hub but should not be a Terra server!
Hard dependencies (missing any prevents Plot System from loading):
-
Multiverse-Core (5+)
- Multiverse-Inventories — recommended so lobby and plots have different inventories
- FastAsyncWorldEdit
- WorldGuard
- LangLibs (see version matrix)
- FancyNpcs (2.4.3+)
- DecentHolograms
Soft / recommended:
-
HeadDB and/or HeadDatabase — for
head(<ID>)items in menus / countries (either works) -
LangUI — language switcher via
/language& companion button - WorldGuardExtraFlags — optional alternative when FAWE/WG region issues appear
Note
VoidGen is no longer required. Plot System uses a built-in empty/skeleton chunk generator for plot and CIM worlds.
If a hard dependency is missing, the console shows something like:
[12:58:17] [Server thread/ERROR]: [ModernPluginLoadingStrategy] Could not load 'plugins/.paper-remapped/PlotSystem-5.0.0.jar' in 'plugins/.paper-remapped'
org.bukkit.plugin.UnknownDependencyException: Unknown/missing dependency plugins: [Multiverse-Core, DecentHolograms]. Please download and install these plugins to run 'Plot-System'.Chat message input is used for the tutorial height stage and optional review feedback typing (you can also use /editfeedback). Player messages must reach the Paper server — make sure your proxy global-chat plugin allows that.
Run the server once so LangLibs creates its folder and config.yml, then fill in the language database credentials.
Tip
Optionally restart to confirm LangLibs connects successfully.
We use FAWE WorldGuard Integration. Players need:
fawe.worldguard
fawe.permpack.basicYou may scope the permpack to the plot server / plot worlds and disable sensitive nodes (worldedit.clipboard.download, worldedit.schematic.share). FAWE region-restrictions must be true.
Prefer disabling FAWE's disk clipboard on the plot server to avoid storage blow-ups with large pastes.
Note
This is not required for the plugin to function correctly. From time to time we have the issue that people cannot change blocks with WorldEdit. As an alternative you can use WGEF+.
Install the latest Plot System from Releases.
Enter your URL and database credentials:
database:
url: jdbc:mariadb://adress:3306/
dbname: plotsystem
username: plotsystem
password: minecraft
max-lifetime: 1800000
connection-timeout: 30000
keepalive-time: 120000
maximum-pool-size: 10SQL user permissions:
SELECT, INSERT, UPDATE, DELETE, CREATEor:
GRANT SELECT, INSERT, UPDATE, DELETE, CREATE ON plotsystem.* TO plotsystem@% WITH GRANT OPTIONThe database is created automatically if it does not exist.
Important
Keep the Minecraft server and the database on the same timezone. Plot System writes some timestamps from the JVM (LocalDateTime.now()), while MariaDB/MySQL may fill others with CURRENT_TIMESTAMP in the DB’s timezone. If those clocks disagree (common when the DB runs in Docker on UTC and the game server uses local time), tutorial / activity dates can be offset by hours.
Docker DB: set TZ on the container (compose environment: TZ: Europe/Vienna, or -e TZ=Europe/Vienna), or mount /etc/localtime.
Host / JVM: use the same zone on the OS (timedatectl) or start Java with -Duser.timezone=Europe/Vienna.
Tip
Go through config.yml and related config pages (commands.yml, items.yml) and verify the smaller settings.
Start the Plot System server, join as an operator (or with plotsystem.admin.pss.*), then configure:
Since v3.0 there is a Build Team table which allows multiple Build Teams to share a single Plot System instance.
/pss buildteam add <Name>
Note
This name is an internal identifier (no spaces/special characters). It is not shown to end users. Find the auto-generated ID with /pss buildteam list.
Important
At least one Build Team always needs to be configured!
Assign reviewers:
/pss buildteam addreviewer <BuildTeam-ID> <Player-Name>
Note
The player does not need to be online but must have joined the server at least once. Reviewer permissions alone are not enough — see Permissions.
Configure each Terra server name (match BungeeCord names when possible):
/pss server add <Name> <BuildTeam-ID>
/pss country add <Code> <Continent> <Material> <CustomModelData?>
Use an ISO 3166-1 Alpha-2 code. Continents: EU, AS, AF, OC, SA, NA.
Material can be a Bukkit material or head(<ID>) (HeadDB / HeadDatabase). Display names go in language files — Translation.
Important
You need at least one Country before creating City Projects.
/pss city add <CityProject-Name> <Country-Code> <Server-Name> <BuildTeam-ID>
Note
CityProject-Name is an internal ID (no spaces/special characters). Player-facing name/description are translated.
Important
You need at least one City Project to create plots.
Add/manage criteria with /pss review and assign them per team with /pss buildteam assigncriteria / removecriteria. See Review System.
Default criteria seed (replace 1 with your build team id):
INSERT INTO build_team_uses_toggle_criteria (criteria_name, build_team_id) VALUES
('built_on_outlines', 1),
('correct_amount_windows_doors', 1),
('correct_facade_colour', 1),
('correct_height', 1),
('correct_roof_colour', 1),
('correct_roof_shape', 1),
('correct_window_type', 1),
('windows_blacked_out', 1);Install Plot System Terra on each Terra server (FAWE required). Restart to generate configs.
server-name: ALPS-2Important
Must match the name configured with /pss server add.
# Possible values: DATABASE, API
data-mode: DATABASEIf API:
api:
api-url: plot.yourdomain.com
port: 8080
api-key: ffffffff-ffff-ffff-ffff-ffffffffffffElse use the same database credentials as the main Plot System plugin.