Skip to content
Aleksi Lassila edited this page Jun 11, 2021 · 27 revisions

Welcome to the Islands wiki!

Here I will give more detailed explanation of how Islands plugin works, how you can set it up and how to further configure the plugin.

Getting Started

Setting up the plugin is fairly easy. First, grab the latest .jar from SpigotMC or releases. After you have moved the .jar to plugins/ folder, add following lines to your bukkit.yml file. You will also have to install VoidGenerator plugin. Alternatively you can use other generators that generate empty worlds too.

worlds:
  <Islands World Name>:
    generator: VoidGenerator:PLAINS

Replace <Islands World Name> with the value of islandsWorldName from plugins/Islands/config.yml. You may want to also make sure that level-name in server.properties matches islandsWorldName. This is because the world specified in level-name holds player inventory data. If you set up automatic wilderness wipes, make sure you are not using the world specified in level-name as wilderness.

Should you not set the world generator for islands world, your islands will spawn in normal world instead of an empty one. If you are using Multiverse to create the world, still add the necessary lines to bukkit.yml before you create the world. Multiverse with this plugin is known to cause some issues with world generation.

GriefPrevention plugin is also required on the server to enable island protection. Islands plugin uses GP to claim new islands for players, and should not interfere with your existing claims in other worlds. See GriefPrevention And Protecting page for more information about protecting and GP.

Also it is recommended to allocate > 2GB of memory to the server, since the plugin needs 2 additional worlds to be active (wilderness and islandSource worlds). If you experience server freezes when creating an island (like my demo server), it's probably because your server can't handle all the worlds.

Optional (but recommended)

You also should set level-type as FLAT in server.properties. This ensures that the "void darkness" starts at level 0. Normal worlds have void darkness start at around level 64, which makes the void below islands look dark if the island is located below level 64.

The plugin will generate wilderness world for you, which is where players will spawn when they jump off their island. You can change the world name with wildernessWorldName in the plugin config. Unless wildernessWorldName is the same as level-name, deleting this world should not wipe players' inventories.

If you have issues with commands overlapping with each other, check out commands.yml on command aliases. I've written some example config lines and instructions here, too.

That's all you need. However, this plugin can do much more than that. Check out these pages to further customize Islands:

If you have a public server with my plugin, feel free to hit me up. I'd be happy to pay you a visit or even play a little :)

Support

You can discuss this plugin at SpigotMC. If you need help you can contact me there or in discord: 0x3A7F14#0001. If you find a bug, you can report it here by creating an issue.

Note that this wiki is most likely full of typos, bad grammar or I may have explained some things unclearly. If you notice any major inconveniences, feel free to edit this wiki or hit me up.

Compiling

Nothing special, except the project uses IF GUI management library. Download that and add it as a library. Make sure you extract the library to the artifact output jar. I will use maven or something in the future I promise