Difference between revisions of "Installation Instructions"

From Legends of Aria Admin and Modding Wiki
Jump to: navigation, search
(Fix microsoft link)
Line 4: Line 4:
  
 
# Extract the server installation package to a folder you have write permissions to. Don't put it in program files. (Download link is in [https://www.legendsofaria.com/forums/discussion/1249/admin-download-links-and-patch-notes/p1 Private Admin Forum])
 
# Extract the server installation package to a folder you have write permissions to. Don't put it in program files. (Download link is in [https://www.legendsofaria.com/forums/discussion/1249/admin-download-links-and-patch-notes/p1 Private Admin Forum])
# Install the [https://www.microsoft.com/en-us/download/details.aspx?id=40784 2013 Microsoft C++ x86 runtime].
+
# NOTE: You may need to install .NET 4.5 run time and the x64 C++ run time if not already present on your system.
## NOTE: If you are running the 64 bit version of the server get the 64 bit runtime
 
## NOTE: Some Lua extensions may also require that you have the [https://www.microsoft.com/en-us/download/details.aspx?id=48145 2015 Runtime] as well.
 
 
 
  
 
== Standalone Shard (Single Region Server) ==
 
== Standalone Shard (Single Region Server) ==
Line 13: Line 10:
 
# Edit the ClusterConfig.xml file for your setup. READ THE comments in the config file explaining each option.
 
# 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
 
# Add an entry in the AccessList.xml for you user id to grant you god access
# Run the game using the "Shard Server" shortcut. If you have issues with the shortcut, create your own running Build/ShardServer.exe with the main folder as the working directory.
+
# 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.
 
# To connect to your server, enter the IP address you used in you the ServerAddresss field of your ClusterConfig.xml.
  
Line 19: Line 16:
 
== Cluster (Multi Region Server) ==
 
== Cluster (Multi Region Server) ==
  
# If you are the cluster admin, you must request a cluster from Citadel Studios. Each admin during Pre­Alpha is allowed one cluster server for free. Email [email protected] to get one.
+
# To get started with clusters, you'll need to use Web Launcher. See the [[Web Launcher Quick Start|Web Launcher Quick Start Guide]] for details.
# Each machine that is running regions must have a full copy of the server including all of your (optional) up to date mod files.
 
# Edit the ClusterConfig.xml file for your setup. READ THE comments in the config file explaining each option. You do not need to edit any of the options in the standalone section.
 
# Using the information in your email from Citadel, setup your [[Cluster_Administration|Cluster Web Interface]].
 
# You can run launcher.py (Requires [https://www.python.org/download/releases/2.7/ Python 2.7]) which gives you control over launching and killing your cluster regions. Alternatively, you can launch a region.
 
# By running the ShardsServer.exe with the region address as the first parameter. Make sure all regions in a cluster have a unique region address.
 
 
 
 
'''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!
 
'''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!
 
[[Category:Server Administration]][[Category:Citadel Studios]]
 
[[Category:Server Administration]][[Category:Citadel Studios]]

Revision as of 00:00, 3 October 2018

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: You may need to install .NET 4.5 run time and the x64 C++ run time if not already present on your system.

Standalone Shard (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.


Cluster (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.

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!