Overview
Install the plugin, create your first world, and find your way around.
Configure and run BuildSystem on Spigot, Paper, or compatible server software.
Your First Ten Minutes
New here? Do these in order and you will have a working build server.
Install it. Drop the jar in
plugins/and start the server on Java 25. The console reports where backups will be stored. Full requirements: Installing BuildSystem.Open the navigator. Run
/worlds. Three tabs ship by default: Worlds, Archive, and Private. They stay empty until you make a world.Create your first world. Click the create item, choose a type, and name it. Creating Worlds covers templates, custom generators, and seeds.
Set its status. In
/worlds edit, click the status item. A world starts at Not Started and flips to In Progress by itself on the first block change. Status is what decides which navigator tab a world appears in.Let your builders in. They need
buildsystem.navigatorfor/worldsandbuildsystem.buildfor build mode. To restrict one world to named people, add them with/worlds addBuilderand enable the builders toggle in/worlds edit. See World Access.
Once the defaults stop fitting, Custom Statuses & Categories shows how to add your own workflow stages and navigator tabs in /setup, and World Backups covers scheduling backups to disk, S3, or SFTP.
Upgrading from v3? Read the Migration Guide first. Conversion is automatic but one-way, so copy plugins/BuildSystem/ before you start.
Navigation
Installing BuildSystem: Server requirements, runtime versions, installation.
Creating Worlds: Command and UI-driven world creation and importing.
Migration Guide: Upgrading from v3 to v4: requirements, automatic conversion, and API changes.
Then, by what you want to do:
Managing Worlds: the World Editor for per-world settings, Statuses & Categories for workflow stages and navigator tabs, Folders for grouping, Custom Generators for third-party terrain, and Backups.
Builder Tools: Player Settings, the Scoreboard, and Custom Blocks.
Reference: every config key, Common Issues, and the Changelog.
Last updated