This guide covers how to set up your Portal Knights dedicated server on Legion Hosting, configure startup variables, adjust server settings, connect with friends, and manage your world saves. For admin controls and player management, see Portal Knights Admin Commands.

1. First Start

1. Log in to GPanel and select your Portal Knights server.
2. Go to the Startup tab and review the available variables (see the table below).
3. Set a SERVER_NAME so you can identify your server in the browser.
4. Change the ADMIN_PASS from the default. Optionally set USER_PASS or GUEST_PASS to restrict access to your group.
5. Return to the Console tab and click Start.
6. Wait for the console to indicate the server has finished loading. The first start will generate default configuration files and a new world.

2. GPanel Startup Variables

The following variables are available in the GPanel Startup tab. These values are applied each time the server starts.

3. Server Configuration

Beyond the startup variables, Portal Knights allows fine-tuning through its server configuration file. Stop your server before making changes.

Configuration File Location

dedicated_server/server_config.json

Open this file using the Files tab in GPanel or connect via SFTP. If the file does not exist, start and stop the server once to generate it with default values.

Key Settings

The configuration file uses JSON format. Key properties include:

Example Configuration

{
  "basicServerData": {
    "name": "My Portal Knights Server",
    "ipv4": "0.0.0.0",
    "port": 27015,
    "saveFolderPath": "./savedata"
  },
  "admins": {
    "credentials": {
      "password": "my_admin_password"
    }
  },
  "users": {
    "credentials": {
      "password": ""
    }
  },
  "guests": {
    "credentials": {
      "password": ""
    }
  },
  "gameplayMode": "Adventure",
  "universeSize": "Normal",
  "hideConsoleWindow": true
}

4. World Settings

Portal Knights worlds consist of procedurally generated islands connected by portals. Key world-related considerations:

• Save Folder: World data is stored in the savedata directory (configured via basicServerData.saveFolderPath in the config).
• Gameplay Mode: Set via the GAMEMODE startup variable. Adventure is the standard RPG experience; Creative allows free building and exploration.
• Universe Size: Set via the UNIVERSE_SIZE startup variable. Controls the number of islands: Small, Normal, or Large.
• Island Progression: Players progress through islands by collecting portal shards and activating portals. The server tracks all discovered islands and their states.

5. How to Connect

Option A -- In-Game Server Browser

1. Launch Portal Knights via Steam.
2. From the main menu, select Multiplayer.
3. Choose Online Game and then Browse Servers.
4. Search for your server by name or browse the list.
5. Select your server and click Join. Enter the password if prompted.

Option B -- Direct Connect via IP

1. Launch Portal Knights via Steam.
2. From the main menu, select Multiplayer.
3. Choose Online Game and then Direct Connect.
4. Enter your server IP and port from GPanel's Network tab:

   <your-server-ip>:<port>

5. Enter the server password if one is set.

6. Save Management

Save File Location

World saves are stored on the server at:

dedicated_server/savedata/

This path is configured via the basicServerData.saveFolderPath setting in server_config.json.

Manual Backups via SFTP

1. Stop the server from GPanel to ensure all data is flushed to disk.
2. Connect to your server via SFTP. See How to Upload Files via SFTP for instructions.
3. Navigate to the dedicated_server/savedata/ directory.
4. Download the entire world folder you want to back up.

Restoring a Save

1. Stop the server from GPanel.
2. Connect via SFTP and navigate to dedicated_server/savedata/.
3. Upload your backed-up world folder, replacing the existing one if needed.
4. Ensure the folder name matches the world_name setting in your configuration.
5. Start the server from GPanel.

Troubleshooting

• Server not appearing in browser: Confirm the server is fully started in GPanel. The server browser may take 2-3 minutes to index a new server. Try direct connect via IP in the meantime.
• Cannot connect: Verify your server IP and port in the GPanel Network tab. Ensure the server is running and not in a crashed state.
• Crashes on startup: Delete the configuration file and restart to regenerate defaults. If the issue persists, check the GPanel console for error messages.
• World not loading: Ensure the basicServerData.saveFolderPath setting in server_config.json points to the correct directory.

Related Articles

• Portal Knights Admin Commands
• How to Find Your Server IP and Port
• How to Upload Files via SFTP
• Server Startup Guide

Need Help?

If you run into issues not covered here, open a support ticket and include your server IP, a description of the problem, and any error messages from the GPanel console.