Getting Started

This guide will help you set up your own server with our mod. Follow these steps to get started.

Installation

1. Download Server Files
   Visit our GitHub Page and download the server files. Choose the version compatible with your operating system (Linux or Windows). Please note that macOS is not supported, and there are no plans to support it in the future.

QuickStart

Setting Up

1. Create a Folder
   On your desktop, create a folder and extract the server files into it.

2. Launch the Server
   Open the folder and run the server application. A terminal window will open, and the server should start automatically.

3. Join the Server
   Connect to your server through the in-game menu using the address 127.0.0.1 and the default port 25555. For detailed joining instructions, refer to our Going Public page.

World Creation

• Initial Setup
  The first player to connect will be responsible for creating the world. It’s recommended to generate the world with the minimum enforced modlist to avoid potential issues.

Configuration Files

ServerConfig File

• Purpose: Configure server settings, values and behaviours.

ActionValues File

• Purpose: Adjust the values for specific actions inside the server.

DifficultyValues File

• Purpose: Configure custom difficulty settings.

Market File

• Purpose: Allows players to list and buy items globally.

RoadValues File

• Purpose: Defines types of roads and their costs and allowance.

ServerValues File

• Purpose: Allows or disallows custom scenarios.

SiteValues File

• Purpose: Adjusts costs and production values for various site types. More information can be found on our Sites Page.

Whitelist File

• Purpose: Configure player access using a whitelist. Add in-game usernames to the list.

WorldConfig File

• Purpose: Stores world data. Avoid editing this file while the server is running.

Troubleshooting

For additional help and information, join our Discord Server.