Skip to content

AetherSky Installation

LocoShailo edited this page Nov 7, 2026 · 1 revision

Installation

1. Install the jar

  1. Stop your server.
  2. Put AetherSky-x.x.x.jar in your plugins/ folder.
  3. (Optional) Install Vault + an economy plugin if upgrades should cost money instead of XP levels.
  4. (Optional) Install AetherDiscord if island events should be posted to Discord.
  5. Start the server.

AetherSky has no runtime downloads: the connection pool is shaded into the jar and the SQLite/MySQL drivers come with Paper.

On the first start you should see something like this in the console:

[AetherSky] Connected to SQLITE storage.
[AetherSky] Loaded 4 OneBlock phases.
[AetherSky] AetherSky enabled - world 'aether_islands', storage SQLITE.
[AetherSky] Loaded 0 islands (next grid index 1).

AetherSky creates these files and folders:

Path What it is
aether_islands/ (server root) The void island world. Created automatically.
plugins/AetherSky/config.yml Main configuration and all messages.
plugins/AetherSky/phases.yml OneBlock phases, block/mob weights and loot tables.
plugins/AetherSky/islands.db SQLite database (only when storage.type: SQLITE).
aether_islands/aethersky-grid.properties Backup of the grid counter. Do not delete.

2. Choose your island modes

Open config.yml:

island:
  modes: [ONEBLOCK, CLASSIC]   # remove one to offer only one mode
  default-mode: ONEBLOCK
  • With two modes, /is opens a Create Your Island menu where the player picks a mode.
  • With one mode, /is creates that island straight away.

3. Set the lobby

Players are sent to the lobby when they leave or delete their island. By default this is the spawn of your main world. To use a different world:

world:
  lobby-world: 'spawn'

4. Test it

  1. Join as a normal player (not OP) and run /is.
  2. Create an island, break a few OneBlocks and open the dashboard again.
  3. Run /aethersky reload after you change config.yml or phases.yml.

Updating

  1. Stop the server.
  2. Replace the jar.
  3. Start the server.

Your islands (database), the island world and your config files are kept.

Important: existing config files are never overwritten. When a new version adds config options, copy the new sections from the default config.yml inside the jar, or rename your old config.yml so a fresh one is generated, then copy your changes back.

Never delete the whole plugins/AetherSky/ folder to "reset the config". It also contains islands.db, which holds all islands.

Uninstalling

Remove the jar. Your data stays in plugins/AetherSky/ (or your MySQL database) and in the aether_islands world folder.

Building from source (developers)

# once: install the AetherDiscord library into your local Maven repository
cd AetherDiscord
mvn install

# build AetherSky
cd AetherSky
mvn clean package

The jar is written to target/AetherSky-x.x.x.jar. AetherSky compiles against the Paper 1.21.4 API and runs unchanged on newer 1.21.x and 26.x servers. AetherDiscord is a provided dependency, so it is not shaded into the jar.

Clone this wiki locally