assistant, editor
31
edits
Changes
Jump to navigation
Jump to search
→User Interface: Added screen shots of the graphical user interface
[[Image:Wurm_unlimited_25pc.png|center|link=http://store.steampowered.com/app/366220]]<br>
This article is intended for advanced users that wish to run a dedicated Wurm Unlimited server. This is not a requirement for playing Wurm Unlimited. Please see the [[WU_Getting_StartedWurm_Unlimited|Getting Started]] guide for running Wurm Unlimited with the bundled server.
==Installation==
:;8766 TCP/UDP: Required for general Steam communication.
:;27016-27030 UDP: Required for Steam queries. This allows the server browsers to see your server through Steam.
:;3724 TCP: The Wurm Unlimited server communicates with clients on this port. (This port may be modified, see [[Server_administration_(Wurm_Unlimited)#Local_Server|Local Server Configuration]])The following ports should be allowed by your firewall only if you are using multiple servers. Even then, you should ensure that your network security only allows traffic from known sources to these ports::;7220, 7221 TCP: '''Warning: Do not under any circumstances open these ports to external access.''' These are ports used for RMI and intra-server communication. These must be open on the local machine but should NOT be publicly available. They bind to the Local IP address. (These ports may be modified, see [[Server_administration_(Wurm_Unlimited)#Local_Server|Local Server Configuration]])
'''Note''': Your server will start without the Steam ports opened, but it will only be visible on the ''LAN'' tab of the server browser, and only to local clients.
====Windows & Linux====
Please see the [[WU_Getting_StartedWurm_Unlimited|Getting Started]] guide for information on installing Steam. Once installed, you will find the ''Wurm Unlimited Dedicated Server'' under the ''Tools'' category of your Steam library. Once installed, you may launch the server by double-clicking the icon on your desktop or by using Steam to launch it. Alternatively, you may launch the server directly by running ''WurmServerLauncher'' in the server's installation folder.
The dedicated server comes with a Java Runtime Environment (JRE) on both platforms, but you may install one for additional debugging tools.
* You must have good knowledge of SQL as well as command-line utilities to run the server in a headless state.
* It's highly recommended that you run the dedicated server on a local system with a graphical interface to perform the initial set up of your server and then copy that server's folder to your headless system.
If you see an error: <tt>[S_API FAIL] SteamAPI_Init() failed; unable to locate a running instance of Steam, or a local steamclient.so.</tt>, you can resolve it by typing this into your root folder:
cp ./linux64/steamclient.so ./nativelibs
To install the server, run SteamCMD and log in with: <tt>login <account> <password></tt> or <tt>login anonymous</tt>. Next you set the install folder by typing <tt>force_install_dir <folder name></tt>, for example: <tt>force_install_dir wu</tt>. Finally, start the update with <tt>app_update 402370</tt>.
====Multi-Server====
A [[Multi_Server_(Wurm_Unlimited)|multi-server setup]] requires more detailed configuration.
==Running the Server==
Xvfb :99 &
export DISPLAY=:99
Once installed, you can launch the server and automatically start it by going into the install folder and typing either <tt>./WurmServerLauncher start=<ServerFolder></tt>. Example: <tt>./WurmServerLauncher start=Creative</tt> ===Command Line Arguments===The server launcher accepts the following command line arguments: ;adminpwd=<password> : Unlocks the admin commands from within the game, that can be used to change the gameplay settings of the server, such as skill gain rate and field growth time. ;epicsettings=<true/false> : If true the server will follow the rules from the Epic servers in Wurm Online. For instance it will use the skill curve. ;externalport=<port> : Used to set the port which the client connects through (Default 3724 TCP) ;homeserver=<true/false> : If the server is a home server ( belongs to a single kingdom ). ;homekingdom=<id> : The kingdom the server belongs to. ;ip=<ip address> : The ip the server will bind to. ;loginserver=<true/false> : Defaults to true, should only be set to false if the server is intended to be connected with another server that is going to act as a loginserver. ;maxplayers=<number> : Sets the max number of players allowed on the server, if this is set through this command line option then the internal game commands to change the player limit will not work. ;pvp=<true/false> : Toggles PvP on or off on the server. ;queryport=<port> : Used to set the steam query port (27016-27030 UDP) ;rmiport<port> : Used for server to server communication. ;rmiregport=<port> : Used for server to server communication. ;servername=<name> : The name of the server that will be visible in server browsers. If the name contains spaces, surround it with "". For example servername="my private server" ;serverpassword=<password> : Sets the password that is used when trying to connect to the server. ;start=<name>: Starts the launcher with the configuration and world data from the subdirectory specified in <name>.
===Launcher Configuration===
===Select Game Database===
[[File:WU_Server_GUI_-_Select_Game_Database.png]]
::;Select database to use: This selects the directory from which the world will be loaded. This list is populated from the game subdirectories of the server executable.
::;Start Server: Starts the server with the current configuration.
This controls aspects of the main server
====1. Server Settings====
[[File:WU_Server_GUI_-_Local_Server_-_Server_Settings.png]]
::;Server Name: This names the server, and will be the name that appears in the server browser lists in the Wurm Unlimited client.
::;Server External IP Address:This is the IP address of the computer on which the server is run. For a new server, this is the external IP address detected by the configuration application for the computer on which it has been launched. When it is run, the server will attempt to bind to this IP address. Note that for computers on a LAN, this will be the IP address of the computer on that LAN. Linux users in particular should check this field, as it may default to 127.0.0.1 if the autodetection fails.
::;Message of the day: A message to display upon login
====2. Advance Server Settings====
[[File:WU_Server_GUI_-_Local_Server_-_Advanced_Server_Settings.png]]
::;Server ID:This number is a unique identifier for the server in a server cluster. When the server gui is first launched with no preconfigured servers, this number is randomly generated so as to avoid clashing with any existing servers ids.
::;Server Internal IP Address: This is the IP address that is used to communicate with other servers. When it is run, the server will attempt to bind to this IP address for inter-server communication. This is also the IP that the RMI ports will bind to.:::'''Note:''' For security purposes, this should be a LAN IP or the local loopback (127.0.0.1). Set to an external (public) IP at your own risk.
::;Server Internal IP Port: This is the port on which the server will communicate with other servers in a multi-server environment.
::;RMI Registration Port: The server allows commands to be executed and information retrieved through Java RMI (Remote Method Invocation). This port is the registration port for RMI calls. RMI is not enabled unless USE_INCOMING_RMI is set to true in the configuration file.
::* Height greater than -1
::* Steepness < 20
====3. Gameplay Tweaks====
[[File:WU_Server_GUI_-_Local_Server_-_Gameplay_Tweaks.png]]
::;Skill gain rate multiplier: Multiplies the server skill gain rate. Higher means faster skill gain. It's not exact depending on a number of factors.
::;Characteristic start value: Start value of Characteristics such as body strength, stamina and soul depth
::;Breeding time modifier: A modifier which makes breeding faster the higher it is.
::;Field growth timer, hour: The number hours between field growth checks
::;Tree Spread Odds: Chance for a Tree with a Sprout to propagate, value is used a % as x/100 chance to propagate.
::;Money pool: This is the amount of money that will be in the money pool after server restart.
====4. Twitter Settings====
The Twitter Settings dropdown contains optional values that, if set, determine what credentials the server uses to post to Twitter.
[[File:WU_Server_GUI_-_Local_Server_-_Twitter_Settings.png]]
::;Consumer key: Twitter consumer key
::;Consumer secret: Twitter consumer secret
::;Application secret: Twitter application secret
====5. Maintenance====
[[File:WU_Server_GUI_-_Local_Server_-_Maintenance.png]]
::;Maintenance:Select to start the server in maintenance mode. A server in maintenance mode does not allow any players of power 0 to connect. Players set to 1 or higher will still be able to connect.
===Server Neighbors===
This tab allows configuration of the network settings for connecting to server neighbours.
[[File:WU_Server_GUI_-_Server_Neighbors.png]]
====1. Server Settings====
::;Server Name: Name of the neighboring server.
::;Login server: The login server is the central cluster node responsible for bank accounts and cross communication
===Server Travel===
This tab configures the direction of travel to neighboring servers. Neighbors need to be configured in the Server Neighbors tab before they will appear in this one.
[[File:WU_Server_GUI_-_Server_Travel.png]]
::;North: Drop-down box to select a server in the current cluster to transfer players to when they travel north.
::;South: Drop-down box to select a server in the current cluster to transfer players to when they travel south.
===Players===
This tab allows changes to specific players
[[File:WU_Server_GUI_-_Players.png]]
::;Select Player: A drop-down box that will populate with players as they are created on the server. You may need to switch to another tab and back to see players created after you've viewed the tab.
Once a player has been chosen from the drop-down, the following options are available:
==Server Configuration file==
On startup, the server reads from the '''wurm.ini''' file in the folder of the server that is loaded from the interface or with the <tt>start=</tt> argument. This configuration file (details of the syntax are specified by Java's [https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html#load-java.io.Reader- Properties.load method]) sets a number of parameters:
===Terrain and Resources===
::;CAVEIMG:When true, the ores on the map will be saved to a file named Ore.png in the server directory on startup. If not specified, defaults to false.
::;DEVMODE: Turns on additional logging and disables email sending. If not specified, defaults to false.
::;LAG_THRESHOLD: Certain long-running operations are logged if they are over a certain threshold, as specified in milliseconds by LAG_THRESHOLD. If not specified, defaults to 1000.
::;PLAYERLOG: Indicates the log file to which player statistics will be written at regular intervals. Must have a .log extension and write access or the default will be used. The syntax of the file path may be in standard Java path format, eg.::::<code>PLAYERLOG=d:/path/to/players.log</code>:::and may be an absolute or a relative path, eg:::::<code>PLAYERLOG=logs/numplayers.log</code>:::If backslash path characters are preferred on a Windows environment, they need to be escaped:::::<code>PLAYERLOG=d:\\path\\to\\players.log</code>:::If not specified, defaults to numplayers.log in the server directory.
::;USE_DATABASE_FOR_SERVER_STATISTICS_LOG: When true, server statistics will be logged to the wurmlogs database. This is in addition to MRTG logging. If not specified, defaults to false.
::;USE_ITEM_TRANSFER_LOG: When true, item transfers are logged to the database.
===Troubleshooting===
:;Server is not visible in the server browser: his This usually indicates that the Steam query ports 27016-27030 are not open, or have not been forwarded to the server host.:;On login, players get this message<nowiki>: </nowiki> <You can not log on to this type of server. Contact a GM or Dev>: This message indicates that the server is not configured to allow logins, using the IS_GAME_SERVER flag. Set IS_GAME_SERVER=true to allow logins on this server.:;Twitter is not working: You may need to download the commons-codec.jar and place it in the ''lib'' folder of your server. The library is available here: [http://commons.apache.org/proper/commons-codec/download_codec.cgi Apache Commons]. Note that this issue should be fixed in current versions.:;On a computer with touchscreen enabled, clicking on a drop down box causes the launcher to stop responding: This is a known issue with JavaFX on Windows 10 with devices using touchscreens. You will need to disable the touchscreen. To do this::# Go to start:# Right click on "This PC" and choose properties:# Choose device manager:# Find "Human Interface Devices":# Find "HID Compliant touch screen", right click and disable.
