ShadowRegions

Everything you need is here. The other files are:

lang/<locale>.yml    translations
menus/<name>.yml     GUI layouts
presets/<name>.yml   flag presets
data/regions/*.yml   the regions (YAML mode)

On update your files are moved to the new version automatically: what you changed is kept, the old copies are in backup/<date>/, and if something needs your attention you will find PORTING-<version>.txt in this folder.

Rules that apply EVERYWHERE, inside regions and outside them. They are for the things that must not happen on the server, full stop. A region watches an area; the blacklist watches an item.

While "enabled" is false this file costs nothing: the listeners leave on their first line.

This is the one file that is meant to be translated. Everything a player reads lives here; nothing here is syntax.

MiniMessage format. Placeholders are written <like-this> and their names are fixed: keep them, move them, but do not rename them. A key missing here is taken from the copy of this same language inside the jar first, then from the default language and from en_US, one key at a time.

A message can be a plain string or a map:

some-key:
  text: "<red>Text"
  channel: ACTION_BAR      # CHAT | ACTION_BAR | TITLE | SUBTITLE | NONE
  sound: block.note_block.bass
  volume: 0.7
  pitch: 0.8
  cooldown: "2s"           # anti spam, per player

Careful with keys like "on", "off", "yes" and "no": YAML reads them as true/false unless they are quoted. Write them as "on": and "off":.

Area editor - docs/11-EDITOR-AREA.md

The shape of the menu: filler, and the slot and item of each button. The words are in lang/<language>.yml under menu.editor, so every player reads them in their own language.

A text written here wins over the language files, for everybody:

title: "<red>Shape of <target>"   shown as it is, in every language
title: "lang:my.key"              a key of your own in the language files

The same goes for "name:" under a button.

Flag categories and grid

The shape of the two flag menus: the nine sections and the grid of one section. The words are in lang/<language>.yml under menu.flags, so every player reads them in their own language.

A text written here wins over the language files, for everybody:

title: "<red>Rules of <region>"   shown as it is, in every language
title: "lang:my.key"              a key of your own in the language files

The same goes for "name:" under a button.

Main panel - /rg gui

The shape of the menu: size, filler, and the slot and item of each button. The words are in lang/<language>.yml under menu.main, so every player reads them in their own language.

A text written here wins over the language files, for everybody:

title: "<red>My zones"        shown as it is, in every language
title: "lang:my.key"          a key of your own in the language files

The same goes for "name:" under a button.

Owners and members of a region

The shape of the menu: filler, and the slot and item of each button. The words are in lang/<language>.yml under menu.members, so every player reads them in their own language.

A text written here wins over the language files, for everybody:

title: "<red>Who builds here"   shown as it is, in every language
title: "lang:my.key"            a key of your own in the language files

The same goes for "name:" under a button.

Flag presets

The shape of the menu: size, filler, content area and the back button. The words are in lang/<language>.yml under menu.presets, so every player reads them in their own language; the name and description of each preset are in its own file, in presets/.

A text written here wins over the language files, for everybody:

title: "<red>Presets"   shown as it is, in every language
title: "lang:my.key"    a key of your own in the language files

The same goes for "name:" under a button.

One region's card

The shape of the menu: size, filler, and the slot and item of each button. The words are in lang/<language>.yml under menu.region, so every player reads them in their own language.

A text written here wins over the language files, for everybody:

title: "<red><region>"   shown as it is, in every language
title: "lang:my.key"     a key of your own in the language files

The same goes for "name:" under a button.

The regions of one world

The shape of the menu: size, filler, content area, and the slot and item of each button. The words are in lang/<language>.yml under menu.regions, so every player reads them in their own language.

A text written here wins over the language files, for everybody:

title: "<red>Zones of <world>"   shown as it is, in every language
title: "lang:my.key"             a key of your own in the language files

The same goes for "name:" under a button and under content.empty.

World picker

The shape of the menu: size, filler, content area and the back button. The words are in lang/<language>.yml under menu.worlds, so every player reads them in their own language.

A text written here wins over the language files, for everybody:

title: "<red>Worlds"   shown as it is, in every language
title: "lang:my.key"   a key of your own in the language files

The same goes for "name:" under a button.