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

1. 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)
2. NOTE: Latest versions of NODE will error when starting up the server. Use Node 10 (https://nodejs.org/dist/latest-v10.x/)
3. 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.
4. 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

1. Open UDP port 3000 for a standalone server, or UDP ports 5001, 3000-3100 for a cluster server
2. Create a firewall rule to allow this traffic (only required if you are running a firewall, which you definitely should! (-; )
3. You also want to check on your firewall rule that Edge Travesal is correctly set to "Allow edge traversal". Otherwise, traffic from other subnets or the Internet won't be possible.
   A good and short "How-To" video can be found here.

Standalone Server (Single Region Server)

1. Edit the ClusterConfig.xml file for your setup. READ THE comments in the config file explaining each option.
2. Add an entry in the AccessList.xml for you user id to grant you god access
3. 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.
4. 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 Server with Web Launcher (Multi Region Server)

1. To get started with clusters, you'll need to use Web Launcher. See the Web Launcher Quick Start Guide for details.

GENERAL WARNING​: The Web Launcher currently seems to be flawed: even if you have set up your cluster server correctly, the Web Launcher might not recognize your cluster server (status as per June 2022)

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!

Cluster Server with Python Launcher (Multi Region Server)

1. Download and extract the server build that includes the cluster server.
   A link to the latest server build can be found in the "LoA Worlds" Discord, in the channel #download-links
2. In the file ClusterConfig.xml add your Server Access Code (this is the long key found on the dashboard) and the Cluster ID (this is your User Id from the dashboard in the format XX-XXXX)
3. In the file ClusterConfig.xml change the entry <StartingRegionAddress> to the region where you want your players to start. Preferrably it's an entry of Category "World" from the section "REGION CONFIGS" in the ClusterConfig.xml file. Use the text in the attribute "Address" to reference a region.
4. In the file AccessList.xml add an entry for your User ID and make sure you add the RegionAdmin True line. Example:

   <AccessList>	
        <Entry>
             <UserId>00-0000</UserId>
             <AccessLevel>God</AccessLevel>
             <RegionAdmin>True</RegionAdmin>
             <Name>YOUR NAME</Name>
        </Entry>
   </AccessList>

5. Run the application "launch.exe" through its shortcut "Cluster Launcher".
6. Recommended start sequence in the Launcher window:
   1. System - Cluster
   2. System - Login
   3. System - TestMap
   4. World - <the region(s) of your choice>