Getting started

Installing Java

Terre requires Java 17 or newer to run, so make sure that you have it installed. You will additionally need to setup the PATH environment variable for Java or use a full path later on.

Downloading and running Terre

Note: At this time, only snapshots versions are available. The application is still a WIP and can cause some problems. Use at your own risk, we are not responsible for lost player and or world data, make sure to create backups before testing. If you encounter any issues, please open a ticket on the issue tracker.

1. Navigate to the latest packages, then look for the Assets section. Download the jar from these assets, which looks similarly to terre-1.0-xxxxxxx.jar.
2. Create a directory on your machine where you want to run the application, for example my-terre. Move the downloaded jar to this directory and rename it to terre.jar.
3. Create a script in the directory, a shell script named start.sh for linux or a batch script named start.bat on Windows. Add the following command to the script and save it.

   java -Xms256M -Xmx2G -jar terre.jar
   

   Note: The Xms and Xmx parameters are used to tune how much memory can be allocated by the application. Xms in the minimum and Xmx is the maximum, you may need to tweak this later.
4. Execute the script when located inside the directory, from the commandline using ./start.sh, ./start.bat or by double clicking on the script.
5. If everything was setup correctly, Terre should now be running. Terre should have created some extra files and directories, your my-terre directory will now look like:

   my-terre/
   ├─ config/
   │  └─ config.yaml
   ├─ logs/
   │  └─ latest.log
   ├─ plugins/
   ├─ terre.jar
   └─ start.sh
   

6. You can now stop Terre by executing the shutdown command in the Terre console, or by pressing Ctrl-C. You can now start configuring Terre.

Supported Terraria versions

• 1.4.0.5
• 1.4.2.3
• 1.4.4.1
• 1.4.4.4
• 1.4.4.5
• 1.4.4.9