Bukkit World Creation#

Note

This guide is intended for the Bukkit version of Terra.

Other Platform Installations

Warning

We will be replacing the server’s default world with a new Terra world.

Because we are working with changes to worlds ensure that you have made the necessary backups before making any destructive changes!

We will be replacing the server’s default world with a new one that uses Terra as its generator.

If you would like to use a world manager like Multiverse Core to create a world instead of manually setting it as outlined here, please refer to Setting a Generator Through a World Manager

Procedure#

  1. Ensure your server is not running.

  2. If you missed it above, please make a backup of any relevant world folders in your server directory.

  3. Configure your server’s world to use the new config as a generator:

  1. Navigate to the bukkit.yml file which is also contained within your server directory, and open it with any text editor.

  2. Assign your new generator to the default world by adding the following lines to the end of the file:

bukkit.yml#
worlds:
  LEVEL_NAME:
    generator: Terra:PACK_ID

Attention

These lines are not present by default, you have to add them yourself!

  1. Replace LEVEL_NAME with the server’s configured level-name. (This can be found in the server.properties file under the ‘level-name’ key. By default, level-name is set to world.)

Here is an example using the default world level-name:

bukkit.yml#
worlds:
  world:
    generator: Terra:PACK_ID

  1. Replace PACK_ID with an installed config pack’s ID. The ID for the default pack that comes pre-installed with Terra is OVERWORLD, so if you have not installed any other config packs, replace PACK_ID with OVERWORLD.

Here is the example above, using the default OVERWORLD config pack:

bukkit.yml#
worlds:
  world:
    generator: Terra:OVERWORLD

  1. Either delete the existing world folder (the name of this folder is covered above) in your server directory, or rename it to something else (for example world_backup).

  2. Boot your server back up.

Note

Your server should re-generate the world folder during startup.

  1. Join your server and check if your new world is using Terra world generation.

If you followed the steps correctly without any errors, then you have successfully set up a server with Terra!

Setting up Another World#

If you have already done this process before and wish to set up another existing world (such as the Nether or End) with a new generator, you can simply add the world under the worlds key like so:

bukkit.yml#
 worlds:
   existing_world_name:
     generator: Terra:EXAMPLE_PACK_1
   another_world_name:
     generator: Terra:EXAMPLE_PACK_2

Tip

We highly recommend listing worlds you have set up for custom generation via a world manager here as well, in the event that the world manager fails. Typically the world manager will be the only thing responsible for assigning generators, but during failure the server will default to this config, and then vanilla generation if not specified.

Using the bukkit config as a fallback will prevent the server defaulting to vanilla generation if failure occurs (which will cause chunk breaks and is very annoying to fix).

Warning

This will only set the generator for worlds that already exist on the server, if a world listed here has not been created, Bukkit will not create a new world. For creating new worlds that are not the default Overworld, Nether, or End worlds, you will have to use a world management plugin.

We do not recommend switching generators on a world that is already in use, you should only set the generator here as a fallback, or if you are setting up the generator for a world that has already been created on the server but has not been generated. For the latter case, you should clear the world data after setting the generator here before starting the server up.

Troubleshooting#

If you run into issues during the world set up process, be sure to check you have followed each step correctly. Check for any errors in your server console/logs and try to interpret what the issue might be.

If you are unable to set up a world successfully, and have attempted to fix any issues yourself, please feel free to ask for help and provide any relevant information and most importantly the before mentioned logs!