On this page

Configuration

Blocktown is configured in plugins/Blocktown/config.yml, which the first start creates with a comment on every key. Edit the file and run /blocktown reload; no restart is needed. An invalid value is reset to its default, for that key only, and the console names the key, the value it found and the value it uses instead.

The default file #

# The size /blocktown build uses when none is given, in blocks: 16 to 64 on Free.
default-size: 64
# The largest square anyone on this server may build. Free stops at 64.
max-size: 64
# Blocks placed per server tick. Lower it if the server lags during a build.
blocks-per-tick: 4000
# Seconds to run /blocktown confirm after /blocktown build.
confirm-seconds: 30
# Air above the tallest building of the square, in blocks. Everything above street level is cleared anyway,
# up to the highest block in the square; this is the least air left over the new roofs.
clear-above: 6
# Plain ground around the square, in blocks, so the build meets the world around it. It is cleared like the square.
border: 4
# Trees in parks, woods and along streets where they are mapped.
trees: true
# The dashed line down the middle of main roads.
lane-marks: true
# Keep a copy of what each build replaces, so /blocktown undo can put it back. Only the last build of each world is kept.
undo: true
# Worlds where builds are allowed, such as [build, city]. Empty: every world.
worlds: []

# Anonymous usage statistics: about a minute after start and then once an hour, a short report
# (plugin, server, Minecraft and Java versions, player counts, the license tier) is sent to
# coolapps.fyi. Never player names, UUIDs or IP addresses.
# /blocktown telemetry shows the exact data of the last report. false turns it off.
telemetry:
  enabled: true

map-data:
  # OpenStreetMap servers (Overpass API), tried in order. Only the square's corners are sent.
  servers:
    - https://overpass.private.coffee/api/interpreter
    - https://maps.mail.ru/osm/tools/overpass/api/interpreter
  # How long to wait for a server, in seconds.
  timeout-seconds: 60

Keys #

Key	Default	What it does
`default-size`	`64`	The size `build` uses when none is given, from 16 to `max-size`.
`max-size`	`64`	The largest size this server allows. On Free it cannot go above 64.
`blocks-per-tick`	`4000`	How fast a build goes in, from 100 to 100,000. A 64 square is 100,000 to 300,000 blocks counting the air it clears, and blocks that are already right are skipped: a few seconds at the default.
`confirm-seconds`	`30`	How long a build waits for `confirm`, from 5 to 600.
`clear-above`	`6`	The least air left above the tallest building, from 0 to 64. Above street level, everything up to the highest block of the square is cleared whatever this says, so nothing old is left floating over the roofs.
`border`	`4`	The ring of plain ground around the square, from 0 to 16. It is cleared like the square.
`trees`	`true`	`false` builds no trees.
`lane-marks`	`true`	`false` leaves main roads plain.
`undo`	`true`	`false` keeps no undo copies and turns `/blocktown undo` off. Copies live in `plugins/Blocktown/undo/`, one per world, usually well under a megabyte. What chests, signs and other blocks with contents held is kept in memory only, until the server restarts.
`worlds`	`[]`	A list of world names, such as `[build, city]`. A build anywhere else is refused.
`map-data.servers`	two Overpass servers	Where the map comes from, tried in order: a busy or failing server passes to the next. By default overpass.private.coffee, then maps.mail.ru, both public servers whose terms allow this use. Any Overpass API address works, including your own or a paid one; whoever runs it sets its terms.
`map-data.timeout-seconds`	`60`	How long to wait for each server, from 5 to 300.

Usage statistics #

Key	Default	What it does
`telemetry.enabled`	`true`	Sends us a small anonymous usage report about a minute after start and then once an hour: versions, player counts (numbers only), the language and the license tier; never player names, UUIDs, IP addresses or the places you build. `false` sends nothing.

/blocktown telemetry shows the exact data of the last report and its report id. What we keep and for how long: privacy policy.