Installation Instructions
Currently only support for Windows will be provided. Running the server on other systems is planned but with no ETA.
See Official_Tutorial_Videos for a video setup guide
- Extract the server installation package to a folder you have write permissions to. Don't put it in program files. (Download link is in Private Admin Forum)
- NOTE: Latest versions of NODE will error when starting up the server. Use Node 10 (https://nodejs.org/dist/latest-v10.x/node-v10.24.0-win-x64.zip)
- NOTE: You may need to install .NET 4.5 runtime and the 2017 Microsoft x64 C++ runtime (https://aka.ms/vs/15/release/vc_redist.x64.exe) if not already present on your system.
- NOTE: You may also need to install the 64bit 2013 C++ runtime depending on your OS. (https://download.microsoft.com/download/2/E/6/2E61CFA4-993B-4DD4-91DA-3737CD5CD6E3/vcredist_x64.exe)
Networking Setup
- You will want to open up and forward if necessary UDP ports 3000-3100 in general. (Range is dependent on your server index, but starts typically at 3000+)
- You'll likewise want to make sure you have a firewall rule allowing this traffic in case you are running a firewall, or have the Windows OS default one enabled.
Standalone Shard (Single Region Server)
- Edit the ClusterConfig.xml file for your setup. READ THE comments in the config file explaining each option.
- Add an entry in the AccessList.xml for you user id to grant you god access
- Run the game using the "Shard Server" shortcut or StandaloneServerLauncher.exe. If you have issues with the shortcut, create your own running Build/ShardServer.exe with the main folder as the working directory.
- To connect to your server, enter the IP address you used in you the ServerAddresss field of your ClusterConfig.xml.
Troubleshooting:
- If you see "globals.lua import failed: error loading module 'LuaXML_lib' from file './Build/base\luatools\x64\LuaXML_lib.dll'", make sure you are running StandaloneServerLauncher.exe as administrator.
Cluster (Multi Region Server)
- To get started with clusters, you'll need to use Web Launcher. See the Web Launcher Quick Start Guide for details.
MODDER WARNING: Mixing different mods on different regions can have unpredictable results so make sure all the regions are running the exact same mod files!
