Skip to content
This repository has been archived by the owner on Jun 23, 2022. It is now read-only.

Modifying a Pack

Polyhedral-Bot edited this page Dec 24, 2021 · 1 revision

This guide will outline the process of duplicating an existing Terra configuration pack for use in personal modification. This guide will not cover how to modify specific features of world generation, only the initial set up required to make edits. If you haven't already, please read the Config Development Introduction for more information before continuing.

If you want to create a new pack from scratch rather than modifying an existing one, please refer to this guide instead.

Procedure

The following steps will walk you through how to duplicate an existing config pack, and set it up for your own use. Click each step to expand for instructions.

1. Navigate to the packs directory.

This will be dependent on what platform you're using:

  • Forge & Fabric - /config/Terra/packs

  • Bukkit - /plugins/Terra/packs


2. Create a new pack directory for your new modified pack.

This involves simply creating a new folder inside the packs folder. The name of this folder doesn't matter, so you're free to name it whatever you feel is suitable. This folder will henceforth be referred to as a pack directory.


3. Extract the contents of the specified pack into your new pack directory.

If you just wish to modify the DEFAULT config pack, extract the contents of default.zip which will already be contained inside the pack directory. Otherwise, you can make a copy of whatever other pack you wish to modify.

TEMPLATE PACK

Alternatively you can use the template config pack if you want a simple baseline configuration to experiment with. In addition to being very simple, the template pack also contains annotated explanations for what many options do. The GitHub repository can be found here.


4. Ensure you have the correct directory structure.

Terra requires a file called the pack manifest to be contained directly inside your pack directory to load correctly. The pack manifest specifies global pack wide configuration options, and will always have the file name pack.yml.

You should verify that the pack manifest is correctly nested like so:

+ CORRECT
/packs/<PACK DIRECTORY>/pack.yml

- INCORRECT
/packs/<FOLDER>/<PACK DIRECTORY>/pack.yml   

5. Edit the pack manifest to fill out your information.
  1. Set up an ID for your new pack:

    1. In your text editor of choice, open up pack.yml, found in the root directory of the new config pack.

    2. Within pack.yml, Change the id to the ID you wish to assign your config, as well as the author to your username like so:

    id: EXAMPLE_ID
    # Replace 'EXAMPLE_ID' with your desired pack ID
    
    author: dfsek
    # Replace 'dfsek' with your username

6. Create a new world using your new pack.

The process of creating a new world will differ between platforms, refer to Creating a Terra World for instructions for your config development platform of choice. This world will be used for previewing any changes made to your pack and should be considered disposable.

You should now have a setup with a new pack duplicated from an existing one, in which you're able to make your own modifications and preview them in the world you just made.

Once you're finished making your changes, you're free to treat this new pack as any other and use it for your own needs!


Clone this wiki locally