Install and first build

Download #

Before you install, check the requirements: Spigot or Paper 1.16.5 or newer, and Java 8 or newer. Folia is not supported. No other plugin is needed.

Install #

1. Put Blocktown-0.1.0.jar in your server's plugins/ folder.

2. Restart the server. Do not use /reload.

3. Watch the console. When it starts, Blocktown prints one line with its version and tier:

   Blocktown v0.1.0 · Free · coolapps.fyi

The first start creates config.yml in plugins/Blocktown/. There is no database to install.

Commands in this guide are written for the game, with a slash (/blocktown status). In the server console, type them without the slash. The short alias /btown works in place of /blocktown.

Your first build #

1. Use a test world #

A build replaces everything inside its square, from the block under your feet up to the highest block above it. Try it first in a world you do not mind changing: a copy of your map, or a new flat world.

2. Stand in the middle #

Go to where the middle of the place should be, and stand on the ground. The block under your feet becomes street level.

3. Build a small square #

Copy the coordinates of a place you know from a map app, and start small:

/blocktown build 60.16975, 24.95215 64

Blocktown marks the square with an orange outline that only you can see, and says how big it is and which heights it replaces. Walk around the outline. If it is in the right place, run /blocktown confirm within 30 seconds; if not, move and run build again.

4. Watch it go in #

The build goes in a few thousand blocks per tick. /blocktown status shows the progress and how many builds this server has left today. When it is done, the chat shows the credit for the map data.

5. Changed your mind? #

/blocktown undo puts back everything the last build replaced or cleared, in the world you are in. Before a restart that includes what chests and signs held; after one, the blocks only.

Who can build #

By default only operators can use /blocktown. To let builders use it without being operators, give them blocktown.build (and blocktown.undo if they may undo). With LuckPerms:

lp group builder permission set blocktown.build true
lp group builder permission set blocktown.undo true

To keep builds to some worlds only, list them under worlds in config.yml. See Configuration.