Wurmpedia - User contributions [en]

Server administration (Wurm Unlimited)

2016-10-02T11:32:56Z

Taufiq: /* User Interface */ Added screen shots of the graphical user interface

<div style="float:right; padding: 10px;">__TOC__</div>
[[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 [[Wurm_Unlimited|Getting Started]] guide for running Wurm Unlimited with the bundled server.

==Installation==
===General Requirements===
====Network Configuration====
The following ports will need to be opened:
:;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.

If your ports are opened on your system's firewall, you may need to have your router forward those ports to your local area IP address. Please refer to your router's manual or your ISP for information on configuring port forwarding on your router.

'''Read more:''' [https://support.steampowered.com/kb_article.php?ref=8571-GLVN-8711 Required Ports for Steam]

====Windows & Linux====
Please see the [[Wurm_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.
* [https://www.java.com/en/download/help/windows_manual_download.xml Windows]
* [https://docs.oracle.com/javase/8/docs/technotes/guides/install/linux_jdk.html Linux RPM]
* [http://www.webupd8.org/2012/09/install-oracle-java-8-in-ubuntu-via-ppa.html Ubuntu/Debian]

====Headless====
The Wurm Unlimited Dedicated Server may be run on a ''headless'' system. This means that the server may be started from the command line without a graphical interface. You will need to install [https://developer.valvesoftware.com/wiki/SteamCMD SteamCMD], from the instructions here: https://developer.valvesoftware.com/wiki/SteamCMD

* Headless mode is '''not''' officially supported by Code Club. The instructions provided have been tested on and are intended for an '''Ubuntu/Debian''' system.
* 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==
===Windows===
You may run the server from within Steam, or by double-clicking the icon on your desktop. Alternatively you may run <tt>WurmServerLauncher.exe</tt> from the installation folder.

===Linux Headless===
The Standard Widget Toolkit for GTK+ Java library and a virtual frame buffer such as Xvfb will need to be installed:
sudo apt-get install libswt-gtk-3-java xvfb
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===
Under most circumstances the server should run without needing customisation of its launch configuration. If necessary however, configuration of the server launcher may be done by editing the configuration file in the following location within your steam folder:
steamapps\common\Wurm Unlimited Dedicated Server\LaunchConfig.ini

This file contains the options for starting the Java runtime. To override the in-built runtime that is used, set the following options in the Runtime section (replace with your own Java path):
OverrideJavaRegEntry=true
JavaPath=C:\Program Files\Java\jdk1.8.0_60\jre\bin\server

==User Interface==
On launch, the server GUI should appear:

===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.
::;Seconds to shutdown: Controls the number of seconds to wait after the shutdown button is pressed before initiating shutdown.
::;Reason for shutdown: When shutdown is initiated, this is broadcast to players as the reason for the shutdown.
::;Shutdown server: Initiates server shutdown, as configured by the seconds to shutdown and reason for shutdown.
::;Modify the current selected database: These allow modification of the currently selected database. A database may be renamed, deleted, or copied under a new name.
===Local Server===
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.
::;Server External IP Port: This is the port on which the server will communicate with clients.
::;Steam password: Servers may allow any Wurm Unlimited client to connect, or to restrict access to those with the required password. If set, players need to provide this in order to connect to your server.
::;Maximum number of players.: This sets the limit on the maximum number of players allowed at any one time. When the server reaches its maximum, no players will be able to connect until another has disconnected.
::;Allow PvP: Allows player-versus-player combat, building destruction and theft.
::;Epic settings: Turns on Epic mode, where skillgain is faster and missions affect Valrei.
::;Home server: A Home server can only have settlements from one kingdom.
::;Kingdom: For Home servers, this value indicates the kingdom to which the server belongs. Built-in kingdom values are:
:::*0 - No kingdom
:::*1 - Jenn-Kellon
:::*2 - Mol-Rehan
:::*3 - Horde of the Summoned
:::*4 - Freedom
::;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.
::;RMI Port: This is the port over which Remote Method Invocation calls are made. RMI is not enabled unless USE_INCOMING_RMI is set to true in the configuration file.
::;Intra server password: When running multiple servers together, this is password is used for cross-server communication.
::;Login server: The login server is the central cluster node responsible for bank accounts and cross communication
::;Test server: Running as a test server turns on a number of additional settings and debug options.
::;Random spawn points: If set, new players with spawn in a randomised location unless a permanent kingdom village is set. If a server has spawn items in the world (eg. Soulstones), the spawn location will be based on one of these items chosen at random.
::;Spawnpoint x: Where players generally spawn, tile x.
::;Spawnpoint y: Where players generally spawn, tile y
::;Kingdom 2 spawnpoint x: Where kingdom 2 players spawn, tile x
::;Kingdom 2 spawnpoint y: Where kingdom 2 players spawn, tile y
::;Kingdom 3 spawnpoint x: Where kingdom 3 players spawn, tile x
::;Kingdom 3 spawnpoint y: Where kingdom 3 players spawn, tile y
:'''Note:''' If no spawn items exist, the location will be on a tile chosen at random in the world, providing it satisfies the following constraints:
::* 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
::;Mind Logic skill start value: Start value of Mind Logic Characteristic (used for controlling vehicles)
::;Body Control skill start value: Start value of Mind Logic Characteristic (used for controlling mounts)
::;Fight skill start value: Affects start value of the overall fighting skill
::;Overall skill start value: Start value of all other skills
::;Player combat rating modifier: Modifies player combat power versus creatures
::;Action speed multiplier: Divides the max standard time an action takes. Higher makes actions faster.
::;Hota Delay: The time in minutes between Hunt Of The Ancients rounds
::;Max Creatures: Maximum number of creatures in the world.
::;Aggressive Creatures: Approximate maximum percentage of aggressive creatures in the world.
::;Settlement upkeep enabled: If enabled, settlements require upkeep money. Once a settlement runs out of upkeep it is disbanded.
::;No deeding costs: If enabled, deeding is free and costs no money
::;Trader max money: The max amount of money a trader will receive from the pool
::;Trader initial money: The initial amount of money a trader will receive from the pool
::;Minimum mining hits required: The minimum number of times you need to mine before a wall disappears
::;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 token: Twitter application token
::;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.
::;Server ID:This number is a unique identifier for the server in a server cluster.
::;Server External IP Address: External IP of the neighboring server.
::;Server External IP Port: Port of the neighboring server.
::;Server Internal IP Address: This is the IP address that is used to communicate with other servers.
::;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.
::;RMI Port: This is the port over which Remote Method Invocation calls are made. RMI is not enabled unless USE_INCOMING_RMI is set to true in the configuration file.
::;Intra server password: When running multiple servers together, this is password is used for cross-server communication.
::;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.
::;East: Drop-down box to select a server in the current cluster to transfer players to when they travel east.
::;West: Drop-down box to select a server in the current cluster to transfer players to when they travel west.
===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:
::;Player Name: The name of the player.
::;Position in X: The X position of the player.
::;Position in Y: The Y position of the player.
::'''Note''': These are ''real'' X and Y positions, not ''tile'' positions.
::;Player Game Management Power: A value that represents the player's current GM level.
:::* 0 - Normal Player. Cannot use any wands.
:::* 1 - Hero: Has limited abilities and can mostly move around invisible and teleport but not see character details or affect anything. They can be given a wand of teleportation to move around with.
:::* 2 - GM: Standard GM-level. This level and above can set players as CA or CM, move players, ban players, lookup player information etc. This level can use the '''ivory wand''' to invoke various GM powers.
:::* 3 - High God: A higher level than GM. There's no significant difference in power between a High God and a GM.
:::* 4 - Arch GM: High level GM that can spawn items and creatures, set skills, shutdown servers, and so on. This level can do nearly everything a level 5 can and has the ability to use the '''ebony wand''' as well as the '''ivory wand'''.
:::* 5 - Implementor: Highest level, very little difference from Arch GM.
::;Server ID of the player: The server ID where the player is currently located. Changing this to a bad value will make the player unable to log in.
::;Whether the player is undead: Allows the player to play as undead.

==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.
::;CREATESEEDS:If true, on startup the server will assign random forage/botanize resources to random tiles. If not specified, defaults to false.
::;PROSPECT:When true, randomly changes any non-exposed ores in the rock layer and sets itself to false when the configuration file is saved. If not specified, defaults to false.
===Database Connections===
::;DB_HOST:Use the specified directory for the database. This option is ignored if the server world directory is chosen through the GUI.
::;USE_LOGIN_DB:When true, uses a separate directory for the login database, otherwise uses the same database directory as DB_HOST. If not specified, defaults to false.
::;LOGIN_DB_HOST:Specifies the directory for the login database. This option is ignored unless USE_LOGIN_DB is true.
===Challenge and Epic===
::;CHALLENGEDAYS: Only used if STARTCHALLENGE is true. The number of days for the challenge timer to run. If not specified, defaults to 30.
::;STARTCHALLENGE: Sets the start and end timers on a challenge server, using the duration specified in CHALLENGEDAYS.
::;WEB_PATH: Certain data such as player ranking, battles and Valrei map entities are written to xml files. This config item specifies the path in which these file will be created.
===Multi-Server===
::;USE_INCOMING_RMI: When true, the server will listen and respond to incoming messages via Java Remote Method Invocation (RMI), which allows command execution and querying by external systems. If not specified, defaults to false. Note that this option should not be enabled without first securing the server host ports, and is not recommended that this be run on a multi-user host as RMI is not inherently secure.
::;IS_GAME_SERVER: When true, indicates that direct login is allowed on this server. It is possible to configure a cluster of servers such that one acts as a dedicated login server, in which case the login server would have this set to false while the others would be true. If not specified, defaults to true.
===Logging===
These settings control the mechanisms and amount of logging that is performed.
::;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.
::;USE_TILE_LOG: When true, logs tile event details to the database. If not specified, defaults to false.
===Maintenance/Diagnostics===
::;ANALYSE_ALL_DB_TABLES: When true, analyses database tables on startup. If not specified, defaults to false.
::;CHECK_WURMLOGS: When true, checks the logs database tables if and only if a database table maintenance task option (ANALYSE_ALL_DB_TABLES) is also true. This is usually a long running task. If not specified, defaults to false.
::;CRASHED: When true, players have their fatigue reset and are given full sleep bonus on startup. This setting is not automatic, and needs to be set to true or false manually. If not set, defaults to false.
::;MAINTAINING: When true, indicates that the server is running in maintenance mode, in which only players with power level > 0 may log in. If not specified, defaults to false.
::;PRUNEDB: If true, removes old players from the database. Players are removed only if all of the following hold:
:::*Player is power 0
:::*Playing time is less that one day
:::*The player last logged out at least three months ago
:::*Player payment expiry date is 0
::'''Note:''' If all the above hold and the player has more than 5 silvers in the bank, 5 silvers is deducted, last logout is set to current time and an email is sent warning of impending account deletion. If not specified, defaults to false.
===Advanced===
The following options are for advanced users only. Changing these may adversely affect your server and is not recommended for live servers without testing.
::;NUMBER_OF_DIRTY_MESH_ROWS_TO_SAVE_EACH_CALL: Number of terrain mesh rows to be saved each time the scheduled executor performs a save.
::;NUMBER_OF_DB_CREATURE_POSITIONS_TO_UPDATE_EACH_TIME: The number of creatures in the database to update each time the creature position updater runs. If not specified, defaults to 500.
::;NUMBER_OF_DB_ITEM_DAMAGES_TO_UPDATE_EACH_TIME: The number of items in the database to update each time the item damage upsdater runs. If not specified, defaults to 500.
::;NUMBER_OF_DB_PLAYER_POSITIONS_TO_UPDATE_EACH_TIME: The number of player positions to update each time the scheduled executor is called. If not specified, defaults to 500.
::;PLAYER_CONN_MILLIS: Number of milliseconds to wait between player connections. If not specified, defaults to 1000.
::;SCHEDULED_EXECUTOR_SERVICE_NUMBER_OF_THREADS: Specifies the number of threads to be allocated to the scheduled executor pool.
::;USE_SCHEDULED_EXECUTOR_TO_UPDATE_PLAYER_POSITION_IN_DATABASE: When true, use a scheduled executor to update player positions in the database instead of the main server thread. If not specified, defaults to false.
::;USE_SCHEDULED_EXECUTOR: When true, use a scheduled executor to write the MRTG logs instead of from the main server thread. If not specified, defaults to false.
::;USE_SCHEDULED_EXECUTOR_TO_COUNT_EGGS: When true, use a schedule executor to count eggs instead of the main server thread. If not specified, defaults to false.
::;USE_SCHEDULED_EXECUTOR_FOR_SERVER: When true, use a scheduled executor to run the Server thread. When false, uses a timer task. If not specified, defaults to false.
::;USE_SCHEDULED_EXECUTOR_TO_SEND_TIME_SYNC: When true, use a scheduled executor to send time sync commands instead of from the main server thread. If not specified, defaults to false.
::;USE_SCHEDULED_EXECUTOR_TO_SWITCH_FATIGUE: When true, use a scheduled executor to update player fatigue instead of in the main server thread. If not specified, defaults to false.
::;USE_SCHEDULED_EXECUTOR_TO_UPDATE_CREATURE_POSITION_IN_DATABASE: When true, use a schedule executor to update a creature's position in the database. If not specified, defaults to false.
::;USE_SCHEDULED_EXECUTOR_TO_UPDATE_ITEM_DAMAGE_IN_DATABASE: When true, use a scheduled executor to update an Item's damage in the database instead of the main server thread. If not specified, defaults to false.
::;USE_SCHEDULED_EXECUTOR_TO_UPDATE_TWITTER: When true, use a schedule executor to update twitter instead of the main server thread. If not specified, defaults to false.
::;USE_DIRECT_BYTE_BUFFERS_FOR_MESHIO: Use direct allocation for reading from and writing to the meshes. If not specified, defaults to false.
::;USE_MULTI_THREADED_BANK_POLLING: When true, multiple threads will be used to poll the banks. If not specified, defaults to false.
::;USE_SCHEDULED_EXECUTOR_TO_TICK_CALENDAR: When true, a scheduled executor is used to tick the calendar instead of the main server thread. If not specified, defaults to false.

===Reserved Options===
The following options are reserved for future and/or internal use and it is recommended that they be left as they are in the default configuration file:
::;CHECK_ALL_DB_TABLES
::;DB_DRIVER
::;DB_PASS
::;DB_PORT
::;DB_USER
::;DBPATH
::;DBSTATS
::;LOGIN_DB_DRIVER
::;LOGIN_DB_PASS
::;LOGIN_DB_PORT
::;LOGIN_DB_USER
::;PREPSTATEMENTS
::;RUNBATCH
::;SITE_DB_DRIVER
::;SITE_DB_HOST
::;SITE_DB_PASS
::;SITE_DB_PORT
::;SITE_DB_USER
::;TRACK_OPEN_DATABASE_RESOURCES
::;USE_POOLED_DB
::;USE_QUEUE_TO_SEND_DATA_TO_PLAYERS
::;USE_SITE_DB
::;USE_SPLIT_CREATURES_TABLE
::;USEDB

===Troubleshooting===
:;Server is not visible in the server browser: 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.

File:WU Server GUI - Players.png

2016-10-02T11:29:58Z

Taufiq: Wurm Unlimited Server GUI, Players tab. This tab allows limited changes to individual players, such as setting their power.

Wurm Unlimited Server GUI, Players tab. This tab allows limited changes to individual players, such as setting their power.

File:WU Server GUI - Server Travel.png

2016-10-02T11:28:26Z

Taufiq: Wurm Unlimited Server GUI, Server Travel tab. 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.

Wurm Unlimited Server GUI, Server Travel tab. 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 - Local Server - Maintenance.png

2016-10-02T11:23:15Z

Taufiq: Corrected name of the dropdown

Wurm Unlimited Server GUI, Local Server tab, Maintenance dropdown. This tab allows server settings to be customised, with options categorised into dropdowns. The Maintenance dropdown contains a single option that determines whether or not the server will start up in maintenance mode, where only players of power 1 or greater may connect.

File:WU Server GUI - Local Server - Twitter Settings.png

2016-10-02T11:22:23Z

Taufiq: Corrected name of the dropdown

Wurm Unlimited Server GUI, Local Server tab, Twitter Settings dropdown. This tab allows server settings to be customised, with options categorised into dropdowns. The Twitter Settings dropdown contains optional values that determine how the server can post to Twitter.

File:WU Server GUI - Local Server - Gameplay Tweaks.png

2016-10-02T11:21:04Z

Taufiq: Corrected name of the dropdown

Wurm Unlimited Server GUI, Local Server tab, Gameplay Tweaks dropdown. This tab allows server settings to be customised, with options categorised into dropdowns. The Gameplay Tweaks dropdown contains options that modify the rules and variables of gameplay mechanics.

File:WU Server GUI - Local Server - Advanced Server Settings.png

2016-10-02T11:18:21Z

Taufiq: Corrected name of the dropdown

Wurm Unlimited Server GUI, Local Server tab, Advanced Server Settings dropdown. This tab allows server settings to be customised, with options categorised into dropdowns. The Advanced Server Settings dropdown contains more advanced options for controlling the initial startup and running of the server, such remote process communication and network bindings, as well as the higher level kingdom configuration.

File:WU Server GUI - Server Neighbors.png

2016-10-02T11:16:46Z

Taufiq: Wurm Unlimited Server GUI, Server Neighbors tab. This tab allows server neighbours to be customised, for when a server is interconnected with other WU servers, allowing travel between them across map boundaries.

Wurm Unlimited Server GUI, Server Neighbors tab. This tab allows server neighbours to be customised, for when a server is interconnected with other WU servers, allowing travel between them across map boundaries.

File:WU Server GUI - Local Server - Maintenance.png

2016-10-02T11:15:21Z

Taufiq: Wurm Unlimited Server GUI, Local Server tab, Server Settings dropdown. This tab allows server settings to be customised, with options categorised into dropdowns. The Maintenance dropdown contains a single option that determines whether or not the serve...

Wurm Unlimited Server GUI, Local Server tab, Server Settings dropdown. This tab allows server settings to be customised, with options categorised into dropdowns. The Maintenance dropdown contains a single option that determines whether or not the server will start up in maintenance mode, where only developers and GMs may log in.

File:WU Server GUI - Local Server - Twitter Settings.png

2016-10-02T11:14:25Z

Taufiq: Wurm Unlimited Server GUI, Local Server tab, Server Settings dropdown. This tab allows server settings to be customised, with options categorised into dropdowns. The Twitter Settings dropdown contains optional values that determine how the server can p...

Wurm Unlimited Server GUI, Local Server tab, Server Settings dropdown. This tab allows server settings to be customised, with options categorised into dropdowns. The Twitter Settings dropdown contains optional values that determine how the server can post to Twitter.

File:WU Server GUI - Local Server - Gameplay Tweaks.png

2016-10-02T11:13:23Z

Taufiq: Wurm Unlimited Server GUI, Local Server tab, Server Settings dropdown. This tab allows server settings to be customised, with options categorised into dropdowns. The Gameplay Tweaks dropdown contains options that modify the rules and variables of gamep...

Wurm Unlimited Server GUI, Local Server tab, Server Settings dropdown. This tab allows server settings to be customised, with options categorised into dropdowns. The Gameplay Tweaks dropdown contains options that modify the rules and variables of gameplay mechanics.

File:WU Server GUI - Local Server - Advanced Server Settings.png

2016-10-02T11:11:54Z

Taufiq: Wurm Unlimited Server GUI, Local Server tab, Server Settings dropdown. This tab allows server settings to be customised, with options categorised into dropdowns. The Advanced Server Settings dropdown contains more advanced options for controlling the i...

Wurm Unlimited Server GUI, Local Server tab, Server Settings dropdown. This tab allows server settings to be customised, with options categorised into dropdowns. The Advanced Server Settings dropdown contains more advanced options for controlling the initial startup and running of the server, such remote process communication and network bindings, as well as the higher level kingdom configuration.

File:WU Server GUI - Local Server - Server Settings.png

2016-10-02T11:09:50Z

Taufiq: Wurm Unlimited Server GUI, Local Server tab, Server Settings dropdown. This tab allows server settings to be customised, with options categorised into dropdowns. The Server Settings dropdown contains the basic, settings that control the startup and bas...

Wurm Unlimited Server GUI, Local Server tab, Server Settings dropdown. This tab allows server settings to be customised, with options categorised into dropdowns. The Server Settings dropdown contains the basic, settings that control the startup and basic running of the server.

File:WU Server GUI - Select Game Database.png

2016-10-02T10:58:48Z

Taufiq: Wurm Unlimited Server GUI, Select Game Database tab. This tab is opened when the server gui is first started up, and allows players to manage the server database selection and to start and stop the server.

Wurm Unlimited Server GUI, Select Game Database tab. This tab is opened when the server gui is first started up, and allows players to manage the server database selection and to start and stop the server.

Server administration (Wurm Unlimited)

2015-12-21T00:37:40Z

Taufiq: Added link to multi-server setup

<div style="float:right; padding: 10px;">__TOC__</div>
[[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 [[Wurm_Unlimited|Getting Started]] guide for running Wurm Unlimited with the bundled server.

==Installation==
===General Requirements===
====Network Configuration====
The following ports will need to be opened:
:;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.

If your ports are opened on your system's firewall, you may need to have your router forward those ports to your local area IP address. Please refer to your router's manual or your ISP for information on configuring port forwarding on your router.

'''Read more:''' [https://support.steampowered.com/kb_article.php?ref=8571-GLVN-8711 Required Ports for Steam]

====Windows & Linux====
Please see the [[Wurm_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.
* [https://www.java.com/en/download/help/windows_manual_download.xml Windows]
* [https://docs.oracle.com/javase/8/docs/technotes/guides/install/linux_jdk.html Linux RPM]
* [http://www.webupd8.org/2012/09/install-oracle-java-8-in-ubuntu-via-ppa.html Ubuntu/Debian]

====Headless====
The Wurm Unlimited Dedicated Server may be run on a ''headless'' system. This means that the server may be started from the command line without a graphical interface. You will need to install [https://developer.valvesoftware.com/wiki/SteamCMD SteamCMD], from the instructions here: https://developer.valvesoftware.com/wiki/SteamCMD

* Headless mode is '''not''' officially supported by Code Club. The instructions provided have been tested on and are intended for an '''Ubuntu/Debian''' system.
* 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==
===Windows===
You may run the server from within Steam, or by double-clicking the icon on your desktop. Alternatively you may run <tt>WurmServerLauncher.exe</tt> from the installation folder.

===Linux Headless===
The Standard Widget Toolkit for GTK+ Java library and a virtual frame buffer such as Xvfb will need to be installed:
sudo apt-get install libswt-gtk-3-java xvfb
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===
Under most circumstances the server should run without needing customisation of its launch configuration. If necessary however, configuration of the server launcher may be done by editing the configuration file in the following location within your steam folder:
steamapps\common\Wurm Unlimited Dedicated Server\LaunchConfig.ini

This file contains the options for starting the Java runtime. To override the in-built runtime that is used, set the following options in the Runtime section (replace with your own Java path):
OverrideJavaRegEntry=true
JavaPath=C:\Program Files\Java\jdk1.8.0_60\jre\bin\server

==User Interface==
On launch, the server GUI should appear:

===Select Game Database===
::;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.
::;Seconds to shutdown: Controls the number of seconds to wait after the shutdown button is pressed before initiating shutdown.
::;Reason for shutdown: When shutdown is initiated, this is broadcast to players as the reason for the shutdown.
::;Shutdown server: Initiates server shutdown, as configured by the seconds to shutdown and reason for shutdown.
::;Modify the current selected database: These allow modification of the currently selected database. A database may be renamed, deleted, or copied under a new name.
===Local Server===
This controls aspects of the main server
====1. Server Settings====
::;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.
::;Server External IP Port: This is the port on which the server will communicate with clients.
::;Steam password: Servers may allow any Wurm Unlimited client to connect, or to restrict access to those with the required password. If set, players need to provide this in order to connect to your server.
::;Maximum number of players.: This sets the limit on the maximum number of players allowed at any one time. When the server reaches its maximum, no players will be able to connect until another has disconnected.
::;Allow PvP: Allows player-versus-player combat, building destruction and theft.
::;Epic settings: Turns on Epic mode, where skillgain is faster and missions affect Valrei.
::;Home server: A Home server can only have settlements from one kingdom.
::;Kingdom: For Home servers, this value indicates the kingdom to which the server belongs. Built-in kingdom values are:
:::*0 - No kingdom
:::*1 - Jenn-Kellon
:::*2 - Mol-Rehan
:::*3 - Horde of the Summoned
:::*4 - Freedom
::;Message of the day: A message to display upon login
====2. Advance Server Settings====
::;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.
::;RMI Port: This is the port over which Remote Method Invocation calls are made. RMI is not enabled unless USE_INCOMING_RMI is set to true in the configuration file.
::;Intra server password: When running multiple servers together, this is password is used for cross-server communication.
::;Login server: The login server is the central cluster node responsible for bank accounts and cross communication
::;Test server: Running as a test server turns on a number of additional settings and debug options.
::;Random spawn points: If set, new players with spawn in a randomised location unless a permanent kingdom village is set. If a server has spawn items in the world (eg. Soulstones), the spawn location will be based on one of these items chosen at random.
::;Spawnpoint x: Where players generally spawn, tile x.
::;Spawnpoint y: Where players generally spawn, tile y
::;Kingdom 2 spawnpoint x: Where kingdom 2 players spawn, tile x
::;Kingdom 2 spawnpoint y: Where kingdom 2 players spawn, tile y
::;Kingdom 3 spawnpoint x: Where kingdom 3 players spawn, tile x
::;Kingdom 3 spawnpoint y: Where kingdom 3 players spawn, tile y
:'''Note:''' If no spawn items exist, the location will be on a tile chosen at random in the world, providing it satisfies the following constraints:
::* Height greater than -1
::* Steepness < 20

====3. Gameplay Tweaks====
::;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
::;Mind Logic skill start value: Start value of Mind Logic Characteristic (used for controlling vehicles)
::;Body Control skill start value: Start value of Mind Logic Characteristic (used for controlling mounts)
::;Fight skill start value: Affects start value of the overall fighting skill
::;Overall skill start value: Start value of all other skills
::;Player combat rating modifier: Modifies player combat power versus creatures
::;Action speed multiplier: Divides the max standard time an action takes. Higher makes actions faster.
::;Hota Delay: The time in minutes between Hunt Of The Ancients rounds
::;Max Creatures: Maximum number of creatures in the world.
::;Aggressive Creatures: Approximate maximum percentage of aggressive creatures in the world.
::;Settlement upkeep enabled: If enabled, settlements require upkeep money. Once a settlement runs out of upkeep it is disbanded.
::;No deeding costs: If enabled, deeding is free and costs no money
::;Trader max money: The max amount of money a trader will receive from the pool
::;Trader initial money: The initial amount of money a trader will receive from the pool
::;Minimum mining hits required: The minimum number of times you need to mine before a wall disappears
::;Breeding time modifier: A modifier which makes breeding faster the higher it is.
::;Field growth timer, hour: The number hours between field growth checks
::;Money pool: This is the amount of money that will be in the money pool after server restart.
====4. Twitter Settings====
::;Consumer key: Twitter consumer key
::;Consumer secret: Twitter consumer secret
::;Application token: Twitter application token
::;Application secret: Twitter application secret
====5. Maintenance====
::;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===
====1. Server Settings====
::;Server Name: Name of the neighboring server.
::;Server ID:This number is a unique identifier for the server in a server cluster.
::;Server External IP Address: External IP of the neighboring server.
::;Server External IP Port: Port of the neighboring server.
::;Server Internal IP Address: This is the IP address that is used to communicate with other servers.
::;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.
::;RMI Port: This is the port over which Remote Method Invocation calls are made. RMI is not enabled unless USE_INCOMING_RMI is set to true in the configuration file.
::;Intra server password: When running multiple servers together, this is password is used for cross-server communication.
::;Login server: The login server is the central cluster node responsible for bank accounts and cross communication
===Server Travel===
::;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.
::;East: Drop-down box to select a server in the current cluster to transfer players to when they travel east.
::;West: Drop-down box to select a server in the current cluster to transfer players to when they travel west.
===Players===
This tab allows changes to specific players
::;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:
::;Player Name: The name of the player.
::;Position in X: The X position of the player.
::;Position in Y: The Y position of the player.
::'''Note''': These are ''real'' X and Y positions, not ''tile'' positions.
::;Player Game Management Power: A value that represents the player's current GM level.
:::* 0 - Normal Player. Cannot use any wands.
:::* 1 - Hero: Has limited abilities and can mostly move around invisible and teleport but not see character details or affect anything. They can be given a wand of teleportation to move around with.
:::* 2 - GM: Standard GM-level. This level and above can set players as CA or CM, move players, ban players, lookup player information etc. This level can use the '''ivory wand''' to invoke various GM powers.
:::* 3 - High God: A higher level than GM. There's no significant difference in power between a High God and a GM.
:::* 4 - Arch GM: High level GM that can spawn items and creatures, set skills, shutdown servers, and so on. This level can do nearly everything a level 5 can and has the ability to use the '''ebony wand''' as well as the '''ivory wand'''.
:::* 5 - Implementor: Highest level, very little difference from Arch GM.
::;Server ID of the player: The server ID where the player is currently located. Changing this to a bad value will make the player unable to log in.
::;Whether the player is undead: Allows the player to play as undead.

==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.
::;CREATESEEDS:If true, on startup the server will assign random forage/botanize resources to random tiles. If not specified, defaults to false.
::;PROSPECT:When true, randomly changes any non-exposed ores in the rock layer and sets itself to false when the configuration file is saved. If not specified, defaults to false.
===Database Connections===
::;DB_HOST:Use the specified directory for the database. This option is ignored if the server world directory is chosen through the GUI.
::;USE_LOGIN_DB:When true, uses a separate directory for the login database, otherwise uses the same database directory as DB_HOST. If not specified, defaults to false.
::;LOGIN_DB_HOST:Specifies the directory for the login database. This option is ignored unless USE_LOGIN_DB is true.
===Challenge and Epic===
::;CHALLENGEDAYS: Only used if STARTCHALLENGE is true. The number of days for the challenge timer to run. If not specified, defaults to 30.
::;STARTCHALLENGE: Sets the start and end timers on a challenge server, using the duration specified in CHALLENGEDAYS.
::;WEB_PATH: Certain data such as player ranking, battles and Valrei map entities are written to xml files. This config item specifies the path in which these file will be created.
===Multi-Server===
::;USE_INCOMING_RMI: When true, the server will listen and respond to incoming messages via Java Remote Method Invocation (RMI), which allows command execution and querying by external systems. If not specified, defaults to false. Note that this option should not be enabled without first securing the server host ports, and is not recommended that this be run on a multi-user host as RMI is not inherently secure.
::;IS_GAME_SERVER: When true, indicates that direct login is allowed on this server. It is possible to configure a cluster of servers such that one acts as a dedicated login server, in which case the login server would have this set to false while the others would be true. If not specified, defaults to true.
===Logging===
These settings control the mechanisms and amount of logging that is performed.
::;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.
::;USE_TILE_LOG: When true, logs tile event details to the database. If not specified, defaults to false.
===Maintenance/Diagnostics===
::;ANALYSE_ALL_DB_TABLES: When true, analyses database tables on startup. If not specified, defaults to false.
::;CHECK_WURMLOGS: When true, checks the logs database tables if and only if a database table maintenance task option (ANALYSE_ALL_DB_TABLES) is also true. This is usually a long running task. If not specified, defaults to false.
::;CRASHED: When true, players have their fatigue reset and are given full sleep bonus on startup. This setting is not automatic, and needs to be set to true or false manually. If not set, defaults to false.
::;MAINTAINING: When true, indicates that the server is running in maintenance mode, in which only players with power level > 0 may log in. If not specified, defaults to false.
::;PRUNEDB: If true, removes old players from the database. Players are removed only if all of the following hold:
:::*Player is power 0
:::*Playing time is less that one day
:::*The player last logged out at least three months ago
:::*Player payment expiry date is 0
::'''Note:''' If all the above hold and the player has more than 5 silvers in the bank, 5 silvers is deducted, last logout is set to current time and an email is sent warning of impending account deletion. If not specified, defaults to false.
===Advanced===
The following options are for advanced users only. Changing these may adversely affect your server and is not recommended for live servers without testing.
::;NUMBER_OF_DIRTY_MESH_ROWS_TO_SAVE_EACH_CALL: Number of terrain mesh rows to be saved each time the scheduled executor performs a save.
::;NUMBER_OF_DB_CREATURE_POSITIONS_TO_UPDATE_EACH_TIME: The number of creatures in the database to update each time the creature position updater runs. If not specified, defaults to 500.
::;NUMBER_OF_DB_ITEM_DAMAGES_TO_UPDATE_EACH_TIME: The number of items in the database to update each time the item damage upsdater runs. If not specified, defaults to 500.
::;NUMBER_OF_DB_PLAYER_POSITIONS_TO_UPDATE_EACH_TIME: The number of player positions to update each time the scheduled executor is called. If not specified, defaults to 500.
::;PLAYER_CONN_MILLIS: Number of milliseconds to wait between player connections. If not specified, defaults to 1000.
::;SCHEDULED_EXECUTOR_SERVICE_NUMBER_OF_THREADS: Specifies the number of threads to be allocated to the scheduled executor pool.
::;USE_SCHEDULED_EXECUTOR_TO_UPDATE_PLAYER_POSITION_IN_DATABASE: When true, use a scheduled executor to update player positions in the database instead of the main server thread. If not specified, defaults to false.
::;USE_SCHEDULED_EXECUTOR: When true, use a scheduled executor to write the MRTG logs instead of from the main server thread. If not specified, defaults to false.
::;USE_SCHEDULED_EXECUTOR_TO_COUNT_EGGS: When true, use a schedule executor to count eggs instead of the main server thread. If not specified, defaults to false.
::;USE_SCHEDULED_EXECUTOR_FOR_SERVER: When true, use a scheduled executor to run the Server thread. When false, uses a timer task. If not specified, defaults to false.
::;USE_SCHEDULED_EXECUTOR_TO_SEND_TIME_SYNC: When true, use a scheduled executor to send time sync commands instead of from the main server thread. If not specified, defaults to false.
::;USE_SCHEDULED_EXECUTOR_TO_SWITCH_FATIGUE: When true, use a scheduled executor to update player fatigue instead of in the main server thread. If not specified, defaults to false.
::;USE_SCHEDULED_EXECUTOR_TO_UPDATE_CREATURE_POSITION_IN_DATABASE: When true, use a schedule executor to update a creature's position in the database. If not specified, defaults to false.
::;USE_SCHEDULED_EXECUTOR_TO_UPDATE_ITEM_DAMAGE_IN_DATABASE: When true, use a scheduled executor to update an Item's damage in the database instead of the main server thread. If not specified, defaults to false.
::;USE_SCHEDULED_EXECUTOR_TO_UPDATE_TWITTER: When true, use a schedule executor to update twitter instead of the main server thread. If not specified, defaults to false.
::;USE_DIRECT_BYTE_BUFFERS_FOR_MESHIO: Use direct allocation for reading from and writing to the meshes. If not specified, defaults to false.
::;USE_MULTI_THREADED_BANK_POLLING: When true, multiple threads will be used to poll the banks. If not specified, defaults to false.
::;USE_SCHEDULED_EXECUTOR_TO_TICK_CALENDAR: When true, a scheduled executor is used to tick the calendar instead of the main server thread. If not specified, defaults to false.

===Reserved Options===
The following options are reserved for future and/or internal use and it is recommended that they be left as they are in the default configuration file:
::;CHECK_ALL_DB_TABLES
::;DB_DRIVER
::;DB_PASS
::;DB_PORT
::;DB_USER
::;DBPATH
::;DBSTATS
::;LOGIN_DB_DRIVER
::;LOGIN_DB_PASS
::;LOGIN_DB_PORT
::;LOGIN_DB_USER
::;PREPSTATEMENTS
::;RUNBATCH
::;SITE_DB_DRIVER
::;SITE_DB_HOST
::;SITE_DB_PASS
::;SITE_DB_PORT
::;SITE_DB_USER
::;TRACK_OPEN_DATABASE_RESOURCES
::;USE_POOLED_DB
::;USE_QUEUE_TO_SEND_DATA_TO_PLAYERS
::;USE_SITE_DB
::;USE_SPLIT_CREATURES_TABLE
::;USEDB

===Troubleshooting===
:;Server is not visible in the server browser: 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.

Seryll lump

2015-12-03T04:59:48Z

Taufiq: Seryll lumps can't be banked. Updated bulk container recommendation

{{itemBox
|image=None.jpg
|creation=no
|result=* [[Seryll lump]]
|improve=no
|combinable=hot
}}
[[CDB|Main]] / [[Skills]] / [[Smithing]] / [[Metallurgy]] / [[{{PAGENAME}}]]

''This reddish metal is believed to exist naturally only on Seris, and be delivered here by envoys from the gods.''

[[Seryll]] was given out as a gift to the community with the [[legacy loyalty bonus]], and it has a small chance of dropping from [[Valrei creatures]]. The [[quality]] varies and is random.

== Notes ==
* Items made from seryll can be smelted into [[lump]] using a [[smelting pot]].
* Because of its value, seryll lump is best stored in a [[magic chest]] or kept in a character's [[inventory]].
* Any [[crate]]s and [[bulk storage bin]]s that are subject to 5% loss of their content once a month (eg. those off-deed) should not be used to store seryll lump.

== Special properties ==
* Armour made of seryll has the same properties as [[glimmersteel]].
* Weapons made of seryll do not have a faster swing timer or do more [[damage]].
* Seryll [[chain barding]] currently does not show "red" in color when placed on a horse.
* Seryll items do have a chance to shatter when [[enchanting]].

== See also ==
* [[Armour]]
* [[Weapons]]
* [[:Category:Seryll products|Seryll products]]

[[Category:Lumps]]
[[Category:Babel/S]]

Sheep

2015-11-22T02:12:21Z

Taufiq: Added note on leading

[[CDB|Main]] / [[:Category:Bestiary|Bestiary]] / '''{{PAGENAME}}'''

{{Creature
|image=Sheep.jpg
|aggro=Passive
|tamable=Yes
|dommable=No
|groomable=Yes
|butcheringprod=[[meat]], [[fat]], [[eye]], [[bladder]]
|eats=grazer
|ridable=No
|breedable=Yes
|swim=No
|lair=Steppe and grass
}}
== Description ==
''A mythical beast of legends, it stares back at you with blood filled eyes and froth around the mouth.''

'''Sheep''' are a domestic [[animal]] which can be found wandering around [[grass]] and [[steppe]].
==Shearing==
Their [[wool]] may be sheared with [[scissors]] to be used in the creation of woollen [[clothing]].
* [[Animal husbandry]] skill controls the quality of the sheared wool.
* Wool bundles drop to ground not the inventory.
* Shearing can usually be done about once each day.
* Sheared wool weight seems to vary on age currently observed:
*: Young, 0.1kg
*: Adolescent, 0.2kg
*: Mature, 0.3kg
*: Aged, 0.4kg
*: Old, 0.5kg
*: Venerable, 0.6kg
* When placed in a [[bulk storage bin]] or [[crate]] the wool splits into 0.1kg bundles.

Shearing gives skill in:
: [[Soul]]
: [[Nature]]
: [[Animal husbandry]]

== Notes ==
* Female sheep may be [[milk]]ed to make [[feta cheese]].
* Male sheep (rams), and young sheep (lambs) have different models.
* Sheep may be white or black in color.
* They can be lead with a rope by anybody without being tamed.
[[File:New_sheep.jpg|frame|right|Rams, lambs, and black sheep.]]
==Reference==
[[:wikipedia:sheep|Sheep]]

[[Category:Bestiary]]
[[Category:Babel/S]]

Small anvil

2015-11-16T01:41:54Z

Taufiq: /* Using */

[[CDB|Main]] / [[Skills]] / [[Smithing]] / [[Blacksmithing]] / '''{{PAGENAME}}'''

{{ItemBox
|name=Small anvil
|image=Small anvil.png
|active=[[mallet]] or [[hammer]]
|passive=[[iron lump]] (2.00 kg)
|group=Tools
|materials=no
|result=* '''{{PAGENAME}}''' (2.00 kg)
|skill=blacksmithing}}

== Description ==
''A small but heavy metal anvil.''

'''Small anvil''' is used in the creation of many small metal crafts. It requires less [[iron lump|iron]] to make than the [[large anvil]].

== Creation ==
The [[quality]] of the hammer or mallet used will affect the chance of success in creating a small anvil. Failure in creation will result in a reduction of 0.20 kg of the weight of the lump.

== Using ==
Activate a "[[glowing]] from heat" [[lump]], right-click the small anvil in your inventory, and 'Create >'. Small anvils need to be in your inventory to be used and unlike the large anvil cannot be used to create items while on the ground. Higher quality anvils increase the chance of successfully creating an item.

{{rare}}
Rare anvils have been seen to produce higher quality output than their regular counterparts.

== Smithing Items ==
=== Decorations ===
* [[Ball]] - [[brass lump|brass]], [[copper lump|copper]], [[gold lump|gold]], [[lead lump|lead]], [[silver lump|silver]], [[steel lump|steel]]
* [[Bracelet]] - gold, silver
* [[Candelabra]] - gold, silver
* [[Chain]] - gold, silver
* [[Large anvil]] - iron
* [[Ring]] - gold, silver
* [[Statuette]] - gold, silver
* [[Statuette of Fo]] - gold, silver
* [[Statuette of Libila]] - gold, silver
* [[Statuette of Magranon]] - gold, silver
* [[Statuette of Vynora]] - gold, silver
=== Locks ===
* [[Door lock]] - iron
* [[Large padlock]] - iron
* [[Lock picks]] - iron, copper, steel
* [[Small padlock]] - iron
=== Miscellaneous ===
* [[Awl blade]] - iron
* [[Butchering knife blade]] - iron
* [[Carving knife blade]] - iron
* [[Chisel blade]] - iron
* [[File blade]] - iron
* [[Fork]] - iron
* [[Hammer head]] - iron
* [[Hatchet head]] - iron
* [[Hooks]] - iron, copper, gold, silver, steel
* [[Hunting arrow head]] - iron, copper, gold, silver, steel
* [[Iron fishing hook]] - iron
* [[Knife (cutlery)|Knife]] - iron
* [[Leather knife blade]] - iron
* [[Pickaxe head]] - iron
* [[Rake blade]] - iron
* [[Rivets]] - iron, [[bronze lump|bronze]], copper, gold, silver, steel
* [[Scissor blade]] - iron
* [[Metal sheet|Sheet]] - gold, silver, steel
* [[Short sword blade]] - iron
* [[Small axe head]] - iron
* [[Spoon]] - iron
* [[Trowel blade]] - iron
* [[War arrow head]] - iron, copper, gold, silver, steel
* [[Wires]] - iron, copper, gold, silver, steel
=== Tools ===
* [[Large nails]] - iron
* [[Needle]] - iron, copper
* [[Pliers]] - iron
* [[Saw]] - iron
* [[Small nails]] - iron
Skills used: [[blacksmithing]], [[blades smithing]], [[jewelry smithing]], [[locksmithing]], [[weapon heads smithing]].

[[Category:Iron products]]
[[Category:Blacksmithing items]]
[[Category:Tools]]
[[Category:Babel/S]]

Small anvil

2015-11-16T01:30:49Z

Taufiq: /* Creation */ Clarified use of hammer/mallet in creation success of the small anvil

[[CDB|Main]] / [[Skills]] / [[Smithing]] / [[Blacksmithing]] / '''{{PAGENAME}}'''

{{ItemBox
|name=Small anvil
|image=Small anvil.png
|active=[[mallet]] or [[hammer]]
|passive=[[iron lump]] (2.00 kg)
|group=Tools
|materials=no
|result=* '''{{PAGENAME}}''' (2.00 kg)
|skill=blacksmithing}}

== Description ==
''A small but heavy metal anvil.''

'''Small anvil''' is used in the creation of many small metal crafts. It requires less [[iron lump|iron]] to make than the [[large anvil]].

== Creation ==
The [[quality]] of the hammer or mallet used will affect the chance of success in creating a small anvil. Failure in creation will result in a reduction of 0.20 kg of the weight of the lump.

== Using ==
Activate a "[[glowing]] from heat" [[lump]], right-click the small anvil in your inventory, and 'Create >'. Small anvils cannot be used to create items when dropped unlike the large anvil

{{rare}}
Rare anvils have been seen to produce higher quality output than their regular counterparts.

== Smithing Items ==
=== Decorations ===
* [[Ball]] - [[brass lump|brass]], [[copper lump|copper]], [[gold lump|gold]], [[lead lump|lead]], [[silver lump|silver]], [[steel lump|steel]]
* [[Bracelet]] - gold, silver
* [[Candelabra]] - gold, silver
* [[Chain]] - gold, silver
* [[Large anvil]] - iron
* [[Ring]] - gold, silver
* [[Statuette]] - gold, silver
* [[Statuette of Fo]] - gold, silver
* [[Statuette of Libila]] - gold, silver
* [[Statuette of Magranon]] - gold, silver
* [[Statuette of Vynora]] - gold, silver
=== Locks ===
* [[Door lock]] - iron
* [[Large padlock]] - iron
* [[Lock picks]] - iron, copper, steel
* [[Small padlock]] - iron
=== Miscellaneous ===
* [[Awl blade]] - iron
* [[Butchering knife blade]] - iron
* [[Carving knife blade]] - iron
* [[Chisel blade]] - iron
* [[File blade]] - iron
* [[Fork]] - iron
* [[Hammer head]] - iron
* [[Hatchet head]] - iron
* [[Hooks]] - iron, copper, gold, silver, steel
* [[Hunting arrow head]] - iron, copper, gold, silver, steel
* [[Iron fishing hook]] - iron
* [[Knife (cutlery)|Knife]] - iron
* [[Leather knife blade]] - iron
* [[Pickaxe head]] - iron
* [[Rake blade]] - iron
* [[Rivets]] - iron, [[bronze lump|bronze]], copper, gold, silver, steel
* [[Scissor blade]] - iron
* [[Metal sheet|Sheet]] - gold, silver, steel
* [[Short sword blade]] - iron
* [[Small axe head]] - iron
* [[Spoon]] - iron
* [[Trowel blade]] - iron
* [[War arrow head]] - iron, copper, gold, silver, steel
* [[Wires]] - iron, copper, gold, silver, steel
=== Tools ===
* [[Large nails]] - iron
* [[Needle]] - iron, copper
* [[Pliers]] - iron
* [[Saw]] - iron
* [[Small nails]] - iron
Skills used: [[blacksmithing]], [[blades smithing]], [[jewelry smithing]], [[locksmithing]], [[weapon heads smithing]].

[[Category:Iron products]]
[[Category:Blacksmithing items]]
[[Category:Tools]]
[[Category:Babel/S]]

Server administration (Wurm Unlimited)

2015-11-06T10:18:36Z

Taufiq: /* Running the Server */ Add command line arguments

<div style="float:right; padding: 10px;">__TOC__</div>
[[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 [[Wurm_Unlimited|Getting Started]] guide for running Wurm Unlimited with the bundled server.

==Installation==
===General Requirements===
====Network Configuration====
The following ports will need to be opened:
:;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.

If your ports are opened on your system's firewall, you may need to have your router forward those ports to your local area IP address. Please refer to your router's manual or your ISP for information on configuring port forwarding on your router.

'''Read more:''' [https://support.steampowered.com/kb_article.php?ref=8571-GLVN-8711 Required Ports for Steam]

====Windows & Linux====
Please see the [[Wurm_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.
* [https://www.java.com/en/download/help/windows_manual_download.xml Windows]
* [https://docs.oracle.com/javase/8/docs/technotes/guides/install/linux_jdk.html Linux RPM]
* [http://www.webupd8.org/2012/09/install-oracle-java-8-in-ubuntu-via-ppa.html Ubuntu/Debian]

====Headless====
The Wurm Unlimited Dedicated Server may be run on a ''headless'' system. This means that the server may be started from the command line without a graphical interface. You will need to install [https://developer.valvesoftware.com/wiki/SteamCMD SteamCMD], from the instructions here: https://developer.valvesoftware.com/wiki/SteamCMD

* Headless mode is '''not''' officially supported by Code Club. The instructions provided have been tested on and are intended for an '''Ubuntu/Debian''' system.
* 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>.

==Running the Server==
===Windows===
You may run the server from within Steam, or by double-clicking the icon on your desktop. Alternatively you may run <tt>WurmServerLauncher.exe</tt> from the installation folder.

===Linux Headless===
The Standard Widget Toolkit for GTK+ Java library and a virtual frame buffer such as Xvfb will need to be installed:
sudo apt-get install libswt-gtk-3-java xvfb
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===
Under most circumstances the server should run without needing customisation of its launch configuration. If necessary however, configuration of the server launcher may be done by editing the configuration file in the following location within your steam folder:
steamapps\common\Wurm Unlimited Dedicated Server\LaunchConfig.ini

This file contains the options for starting the Java runtime. To override the in-built runtime that is used, set the following options in the Runtime section (replace with your own Java path):
OverrideJavaRegEntry=true
JavaPath=C:\Program Files\Java\jdk1.8.0_60\jre\bin\server

==User Interface==
On launch, the server GUI should appear:

===Select Game Database===
::;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.
::;Seconds to shutdown: Controls the number of seconds to wait after the shutdown button is pressed before initiating shutdown.
::;Reason for shutdown: When shutdown is initiated, this is broadcast to players as the reason for the shutdown.
::;Shutdown server: Initiates server shutdown, as configured by the seconds to shutdown and reason for shutdown.
::;Modify the current selected database: These allow modification of the currently selected database. A database may be renamed, deleted, or copied under a new name.
===Local Server===
This controls aspects of the main server
====1. Server Settings====
::;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.
::;Server External IP Port: This is the port on which the server will communicate with clients.
::;Steam password: Servers may allow any Wurm Unlimited client to connect, or to restrict access to those with the required password. If set, players need to provide this in order to connect to your server.
::;Maximum number of players.: This sets the limit on the maximum number of players allowed at any one time. When the server reaches its maximum, no players will be able to connect until another has disconnected.
::;Allow PvP: Allows player-versus-player combat, building destruction and theft.
::;Epic settings: Turns on Epic mode, where skillgain is faster and missions affect Valrei.
::;Home server: A Home server can only have settlements from one kingdom.
::;Kingdom: For Home servers, this value indicates the kingdom to which the server belongs. Built-in kingdom values are:
:::*0 - No kingdom
:::*1 - Jenn-Kellon
:::*2 - Mol-Rehan
:::*3 - Horde of the Summoned
:::*4 - Freedom
::;Message of the day: A message to display upon login
====2. Advance Server Settings====
::;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.
::;RMI Port: This is the port over which Remote Method Invocation calls are made. RMI is not enabled unless USE_INCOMING_RMI is set to true in the configuration file.
::;Intra server password: When running multiple servers together, this is password is used for cross-server communication.
::;Login server: The login server is the central cluster node responsible for bank accounts and cross communication
::;Test server: Running as a test server turns on a number of additional settings and debug options.
::;Random spawn points: If set, new players with spawn in a randomised location unless a permanent kingdom village is set. If a server has spawn items in the world (eg. Soulstones), the spawn location will be based on one of these items chosen at random.
::;Spawnpoint x: Where players generally spawn, tile x.
::;Spawnpoint y: Where players generally spawn, tile y
::;Kingdom 2 spawnpoint x: Where kingdom 2 players spawn, tile x
::;Kingdom 2 spawnpoint y: Where kingdom 2 players spawn, tile y
::;Kingdom 3 spawnpoint x: Where kingdom 3 players spawn, tile x
::;Kingdom 3 spawnpoint y: Where kingdom 3 players spawn, tile y
:'''Note:''' If no spawn items exist, the location will be on a tile chosen at random in the world, providing it satisfies the following constraints:
::* Height greater than -1
::* Steepness < 20

====3. Gameplay Tweaks====
::;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
::;Mind Logic skill start value: Start value of Mind Logic Characteristic (used for controlling vehicles)
::;Body Control skill start value: Start value of Mind Logic Characteristic (used for controlling mounts)
::;Fight skill start value: Affects start value of the overall fighting skill
::;Overall skill start value: Start value of all other skills
::;Player combat rating modifier: Modifies player combat power versus creatures
::;Action speed multiplier: Divides the max standard time an action takes. Higher makes actions faster.
::;Hota Delay: The time in minutes between Hunt Of The Ancients rounds
::;Max Creatures: Maximum number of creatures in the world.
::;Aggressive Creatures: Approximate maximum percentage of aggressive creatures in the world.
::;Settlement upkeep enabled: If enabled, settlements require upkeep money. Once a settlement runs out of upkeep it is disbanded.
::;No deeding costs: If enabled, deeding is free and costs no money
::;Trader max money: The max amount of money a trader will receive from the pool
::;Trader initial money: The initial amount of money a trader will receive from the pool
::;Minimum mining hits required: The minimum number of times you need to mine before a wall disappears
::;Breeding time modifier: A modifier which makes breeding faster the higher it is.
::;Field growth timer, hour: The number hours between field growth checks
::;Money pool: This is the amount of money that will be in the money pool after server restart.
====4. Twitter Settings====
::;Consumer key: Twitter consumer key
::;Consumer secret: Twitter consumer secret
::;Application token: Twitter application token
::;Application secret: Twitter application secret
====5. Maintenance====
::;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===
====1. Server Settings====
::;Server Name: Name of the neighboring server.
::;Server ID:This number is a unique identifier for the server in a server cluster.
::;Server External IP Address: External IP of the neighboring server.
::;Server External IP Port: Port of the neighboring server.
::;Server Internal IP Address: This is the IP address that is used to communicate with other servers.
::;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.
::;RMI Port: This is the port over which Remote Method Invocation calls are made. RMI is not enabled unless USE_INCOMING_RMI is set to true in the configuration file.
::;Intra server password: When running multiple servers together, this is password is used for cross-server communication.
::;Login server: The login server is the central cluster node responsible for bank accounts and cross communication
===Server Travel===
::;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.
::;East: Drop-down box to select a server in the current cluster to transfer players to when they travel east.
::;West: Drop-down box to select a server in the current cluster to transfer players to when they travel west.
===Players===
This tab allows changes to specific players
::;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:
::;Player Name: The name of the player.
::;Position in X: The X position of the player.
::;Position in Y: The Y position of the player.
::'''Note''': These are ''real'' X and Y positions, not ''tile'' positions.
::;Player Game Management Power: A value that represents the player's current GM level.
:::* 0 - Normal Player. Cannot use any wands.
:::* 1 - Hero: Has limited abilities and can mostly move around invisible and teleport but not see character details or affect anything. They can be given a wand of teleportation to move around with.
:::* 2 - GM: Standard GM-level. This level and above can set players as CA or CM, move players, ban players, lookup player information etc. This level can use the '''ivory wand''' to invoke various GM powers.
:::* 3 - High God: A higher level than GM. There's no significant difference in power between a High God and a GM.
:::* 4 - Arch GM: High level GM that can spawn items and creatures, set skills, shutdown servers, and so on. This level can do nearly everything a level 5 can and has the ability to use the '''ebony wand''' as well as the '''ivory wand'''.
:::* 5 - Implementor: Highest level, very little difference from Arch GM.
::;Server ID of the player: The server ID where the player is currently located. Changing this to a bad value will make the player unable to log in.
::;Whether the player is undead: Allows the player to play as undead.

==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.
::;CREATESEEDS:If true, on startup the server will assign random forage/botanize resources to random tiles. If not specified, defaults to false.
::;PROSPECT:When true, randomly changes any non-exposed ores in the rock layer and sets itself to false when the configuration file is saved. If not specified, defaults to false.
===Database Connections===
::;DB_HOST:Use the specified directory for the database. This option is ignored if the server world directory is chosen through the GUI.
::;USE_LOGIN_DB:When true, uses a separate directory for the login database, otherwise uses the same database directory as DB_HOST. If not specified, defaults to false.
::;LOGIN_DB_HOST:Specifies the directory for the login database. This option is ignored unless USE_LOGIN_DB is true.
===Challenge and Epic===
::;CHALLENGEDAYS: Only used if STARTCHALLENGE is true. The number of days for the challenge timer to run. If not specified, defaults to 30.
::;STARTCHALLENGE: Sets the start and end timers on a challenge server, using the duration specified in CHALLENGEDAYS.
::;WEB_PATH: Certain data such as player ranking, battles and Valrei map entities are written to xml files. This config item specifies the path in which these file will be created.
===Multi-Server===
::;USE_INCOMING_RMI: When true, the server will listen and respond to incoming messages via Java Remote Method Invocation (RMI), which allows command execution and querying by external systems. If not specified, defaults to false. Note that this option should not be enabled without first securing the server host ports, and is not recommended that this be run on a multi-user host as RMI is not inherently secure.
::;IS_GAME_SERVER: When true, indicates that direct login is allowed on this server. It is possible to configure a cluster of servers such that one acts as a dedicated login server, in which case the login server would have this set to false while the others would be true. If not specified, defaults to true.
===Logging===
These settings control the mechanisms and amount of logging that is performed.
::;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.
::;USE_TILE_LOG: When true, logs tile event details to the database. If not specified, defaults to false.
===Maintenance/Diagnostics===
::;ANALYSE_ALL_DB_TABLES: When true, analyses database tables on startup. If not specified, defaults to false.
::;CHECK_WURMLOGS: When true, checks the logs database tables if and only if a database table maintenance task option (ANALYSE_ALL_DB_TABLES) is also true. This is usually a long running task. If not specified, defaults to false.
::;CRASHED: When true, players have their fatigue reset and are given full sleep bonus on startup. This setting is not automatic, and needs to be set to true or false manually. If not set, defaults to false.
::;MAINTAINING: When true, indicates that the server is running in maintenance mode, in which only players with power level > 0 may log in. If not specified, defaults to false.
::;PRUNEDB: If true, removes old players from the database. Players are removed only if all of the following hold:
:::*Player is power 0
:::*Playing time is less that one day
:::*The player last logged out at least three months ago
:::*Player payment expiry date is 0
::'''Note:''' If all the above hold and the player has more than 5 silvers in the bank, 5 silvers is deducted, last logout is set to current time and an email is sent warning of impending account deletion. If not specified, defaults to false.
===Advanced===
The following options are for advanced users only. Changing these may adversely affect your server and is not recommended for live servers without testing.
::;NUMBER_OF_DIRTY_MESH_ROWS_TO_SAVE_EACH_CALL: Number of terrain mesh rows to be saved each time the scheduled executor performs a save.
::;NUMBER_OF_DB_CREATURE_POSITIONS_TO_UPDATE_EACH_TIME: The number of creatures in the database to update each time the creature position updater runs. If not specified, defaults to 500.
::;NUMBER_OF_DB_ITEM_DAMAGES_TO_UPDATE_EACH_TIME: The number of items in the database to update each time the item damage upsdater runs. If not specified, defaults to 500.
::;NUMBER_OF_DB_PLAYER_POSITIONS_TO_UPDATE_EACH_TIME: The number of player positions to update each time the scheduled executor is called. If not specified, defaults to 500.
::;PLAYER_CONN_MILLIS: Number of milliseconds to wait between player connections. If not specified, defaults to 1000.
::;SCHEDULED_EXECUTOR_SERVICE_NUMBER_OF_THREADS: Specifies the number of threads to be allocated to the scheduled executor pool.
::;USE_SCHEDULED_EXECUTOR_TO_UPDATE_PLAYER_POSITION_IN_DATABASE: When true, use a scheduled executor to update player positions in the database instead of the main server thread. If not specified, defaults to false.
::;USE_SCHEDULED_EXECUTOR: When true, use a scheduled executor to write the MRTG logs instead of from the main server thread. If not specified, defaults to false.
::;USE_SCHEDULED_EXECUTOR_TO_COUNT_EGGS: When true, use a schedule executor to count eggs instead of the main server thread. If not specified, defaults to false.
::;USE_SCHEDULED_EXECUTOR_FOR_SERVER: When true, use a scheduled executor to run the Server thread. When false, uses a timer task. If not specified, defaults to false.
::;USE_SCHEDULED_EXECUTOR_TO_SEND_TIME_SYNC: When true, use a scheduled executor to send time sync commands instead of from the main server thread. If not specified, defaults to false.
::;USE_SCHEDULED_EXECUTOR_TO_SWITCH_FATIGUE: When true, use a scheduled executor to update player fatigue instead of in the main server thread. If not specified, defaults to false.
::;USE_SCHEDULED_EXECUTOR_TO_UPDATE_CREATURE_POSITION_IN_DATABASE: When true, use a schedule executor to update a creature's position in the database. If not specified, defaults to false.
::;USE_SCHEDULED_EXECUTOR_TO_UPDATE_ITEM_DAMAGE_IN_DATABASE: When true, use a scheduled executor to update an Item's damage in the database instead of the main server thread. If not specified, defaults to false.
::;USE_SCHEDULED_EXECUTOR_TO_UPDATE_TWITTER: When true, use a schedule executor to update twitter instead of the main server thread. If not specified, defaults to false.
::;USE_DIRECT_BYTE_BUFFERS_FOR_MESHIO: Use direct allocation for reading from and writing to the meshes. If not specified, defaults to false.
::;USE_MULTI_THREADED_BANK_POLLING: When true, multiple threads will be used to poll the banks. If not specified, defaults to false.
::;USE_SCHEDULED_EXECUTOR_TO_TICK_CALENDAR: When true, a scheduled executor is used to tick the calendar instead of the main server thread. If not specified, defaults to false.

===Reserved Options===
The following options are reserved for future and/or internal use and it is recommended that they be left as they are in the default configuration file:
::;CHECK_ALL_DB_TABLES
::;DB_DRIVER
::;DB_PASS
::;DB_PORT
::;DB_USER
::;DBPATH
::;DBSTATS
::;LOGIN_DB_DRIVER
::;LOGIN_DB_PASS
::;LOGIN_DB_PORT
::;LOGIN_DB_USER
::;PREPSTATEMENTS
::;RUNBATCH
::;SITE_DB_DRIVER
::;SITE_DB_HOST
::;SITE_DB_PASS
::;SITE_DB_PORT
::;SITE_DB_USER
::;TRACK_OPEN_DATABASE_RESOURCES
::;USE_POOLED_DB
::;USE_QUEUE_TO_SEND_DATA_TO_PLAYERS
::;USE_SITE_DB
::;USE_SPLIT_CREATURES_TABLE
::;USEDB

===Troubleshooting===
:;Server is not visible in the server browser: 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.

Server administration (Wurm Unlimited)

2015-10-30T01:45:16Z

Taufiq: Added warning for RMI ports, since people insist on advising others that they need to open them up

<div style="float:right; padding: 10px;">__TOC__</div>
[[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 [[Wurm_Unlimited|Getting Started]] guide for running Wurm Unlimited with the bundled server.

==Installation==
===General Requirements===
====Network Configuration====
The following ports will need to be opened:
:;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.

If your ports are opened on your system's firewall, you may need to have your router forward those ports to your local area IP address. Please refer to your router's manual or your ISP for information on configuring port forwarding on your router.

'''Read more:''' [https://support.steampowered.com/kb_article.php?ref=8571-GLVN-8711 Required Ports for Steam]

====Windows & Linux====
Please see the [[Wurm_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.
* [https://www.java.com/en/download/help/windows_manual_download.xml Windows]
* [https://docs.oracle.com/javase/8/docs/technotes/guides/install/linux_jdk.html Linux RPM]
* [http://www.webupd8.org/2012/09/install-oracle-java-8-in-ubuntu-via-ppa.html Ubuntu/Debian]

====Headless====
The Wurm Unlimited Dedicated Server may be run on a ''headless'' system. This means that the server may be started from the command line without a graphical interface. You will need to install [https://developer.valvesoftware.com/wiki/SteamCMD SteamCMD], from the instructions here: https://developer.valvesoftware.com/wiki/SteamCMD

* Headless mode is '''not''' officially supported by Code Club. The instructions provided have been tested on and are intended for an '''Ubuntu/Debian''' system.
* 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>.

==Running the Server==
===Windows===
You may run the server from within Steam, or by double-clicking the icon on your desktop. Alternatively you may run <tt>WurmServerLauncher.exe</tt> from the installation folder.

===Linux Headless===
The Standard Widget Toolkit for GTK+ Java library and a virtual frame buffer such as Xvfb will need to be installed:
sudo apt-get install libswt-gtk-3-java xvfb
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>

===Launcher Configuration===
Under most circumstances the server should run without needing customisation of its launch configuration. If necessary however, configuration of the server launcher may be done by editing the configuration file in the following location within your steam folder:
steamapps\common\Wurm Unlimited Dedicated Server\LaunchConfig.ini

This file contains the options for starting the Java runtime. To override the in-built runtime that is used, set the following options in the Runtime section (replace with your own Java path):
OverrideJavaRegEntry=true
JavaPath=C:\Program Files\Java\jdk1.8.0_60\jre\bin\server

==User Interface==
On launch, the server GUI should appear:

===Select Game Database===
::;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.
::;Seconds to shutdown: Controls the number of seconds to wait after the shutdown button is pressed before initiating shutdown.
::;Reason for shutdown: When shutdown is initiated, this is broadcast to players as the reason for the shutdown.
::;Shutdown server: Initiates server shutdown, as configured by the seconds to shutdown and reason for shutdown.
::;Modify the current selected database: These allow modification of the currently selected database. A database may be renamed, deleted, or copied under a new name.
===Local Server===
This controls aspects of the main server
====1. Server Settings====
::;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.
::;Server External IP Port: This is the port on which the server will communicate with clients.
::;Steam password: Servers may allow any Wurm Unlimited client to connect, or to restrict access to those with the required password. If set, players need to provide this in order to connect to your server.
::;Maximum number of players.: This sets the limit on the maximum number of players allowed at any one time. When the server reaches its maximum, no players will be able to connect until another has disconnected.
::;Allow PvP: Allows player-versus-player combat, building destruction and theft.
::;Epic settings: Turns on Epic mode, where skillgain is faster and missions affect Valrei.
::;Home server: A Home server can only have settlements from one kingdom.
::;Kingdom: For Home servers, this value indicates the kingdom to which the server belongs. Built-in kingdom values are:
:::*0 - No kingdom
:::*1 - Jenn-Kellon
:::*2 - Mol-Rehan
:::*3 - Horde of the Summoned
:::*4 - Freedom
::;Message of the day: A message to display upon login
====2. Advance Server Settings====
::;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.
::;RMI Port: This is the port over which Remote Method Invocation calls are made. RMI is not enabled unless USE_INCOMING_RMI is set to true in the configuration file.
::;Intra server password: When running multiple servers together, this is password is used for cross-server communication.
::;Login server: The login server is the central cluster node responsible for bank accounts and cross communication
::;Test server: Running as a test server turns on a number of additional settings and debug options.
::;Random spawn points: If set, new players with spawn in a randomised location unless a permanent kingdom village is set. If a server has spawn items in the world (eg. Soulstones), the spawn location will be based on one of these items chosen at random.
::;Spawnpoint x: Where players generally spawn, tile x.
::;Spawnpoint y: Where players generally spawn, tile y
::;Kingdom 2 spawnpoint x: Where kingdom 2 players spawn, tile x
::;Kingdom 2 spawnpoint y: Where kingdom 2 players spawn, tile y
::;Kingdom 3 spawnpoint x: Where kingdom 3 players spawn, tile x
::;Kingdom 3 spawnpoint y: Where kingdom 3 players spawn, tile y
:'''Note:''' If no spawn items exist, the location will be on a tile chosen at random in the world, providing it satisfies the following constraints:
::* Height greater than -1
::* Steepness < 20

====3. Gameplay Tweaks====
::;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
::;Mind Logic skill start value: Start value of Mind Logic Characteristic (used for controlling vehicles)
::;Body Control skill start value: Start value of Mind Logic Characteristic (used for controlling mounts)
::;Fight skill start value: Affects start value of the overall fighting skill
::;Overall skill start value: Start value of all other skills
::;Player combat rating modifier: Modifies player combat power versus creatures
::;Action speed multiplier: Divides the max standard time an action takes. Higher makes actions faster.
::;Hota Delay: The time in minutes between Hunt Of The Ancients rounds
::;Max Creatures: Maximum number of creatures in the world.
::;Aggressive Creatures: Approximate maximum percentage of aggressive creatures in the world.
::;Settlement upkeep enabled: If enabled, settlements require upkeep money. Once a settlement runs out of upkeep it is disbanded.
::;No deeding costs: If enabled, deeding is free and costs no money
::;Trader max money: The max amount of money a trader will receive from the pool
::;Trader initial money: The initial amount of money a trader will receive from the pool
::;Minimum mining hits required: The minimum number of times you need to mine before a wall disappears
::;Breeding time modifier: A modifier which makes breeding faster the higher it is.
::;Field growth timer, hour: The number hours between field growth checks
::;Money pool: This is the amount of money that will be in the money pool after server restart.
====4. Twitter Settings====
::;Consumer key: Twitter consumer key
::;Consumer secret: Twitter consumer secret
::;Application token: Twitter application token
::;Application secret: Twitter application secret
====5. Maintenance====
::;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===
====1. Server Settings====
::;Server Name: Name of the neighboring server.
::;Server ID:This number is a unique identifier for the server in a server cluster.
::;Server External IP Address: External IP of the neighboring server.
::;Server External IP Port: Port of the neighboring server.
::;Server Internal IP Address: This is the IP address that is used to communicate with other servers.
::;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.
::;RMI Port: This is the port over which Remote Method Invocation calls are made. RMI is not enabled unless USE_INCOMING_RMI is set to true in the configuration file.
::;Intra server password: When running multiple servers together, this is password is used for cross-server communication.
::;Login server: The login server is the central cluster node responsible for bank accounts and cross communication
===Server Travel===
::;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.
::;East: Drop-down box to select a server in the current cluster to transfer players to when they travel east.
::;West: Drop-down box to select a server in the current cluster to transfer players to when they travel west.
===Players===
This tab allows changes to specific players
::;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:
::;Player Name: The name of the player.
::;Position in X: The X position of the player.
::;Position in Y: The Y position of the player.
::'''Note''': These are ''real'' X and Y positions, not ''tile'' positions.
::;Player Game Management Power: A value that represents the player's current GM level.
:::* 0 - Normal Player. Cannot use any wands.
:::* 1 - Hero: Has limited abilities and can mostly move around invisible and teleport but not see character details or affect anything. They can be given a wand of teleportation to move around with.
:::* 2 - GM: Standard GM-level. This level and above can set players as CA or CM, move players, ban players, lookup player information etc. This level can use the '''ivory wand''' to invoke various GM powers.
:::* 3 - High God: A higher level than GM. There's no significant difference in power between a High God and a GM.
:::* 4 - Arch GM: High level GM that can spawn items and creatures, set skills, shutdown servers, and so on. This level can do nearly everything a level 5 can and has the ability to use the '''ebony wand''' as well as the '''ivory wand'''.
:::* 5 - Implementor: Highest level, very little difference from Arch GM.
::;Server ID of the player: The server ID where the player is currently located. Changing this to a bad value will make the player unable to log in.
::;Whether the player is undead: Allows the player to play as undead.

==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.
::;CREATESEEDS:If true, on startup the server will assign random forage/botanize resources to random tiles. If not specified, defaults to false.
::;PROSPECT:When true, randomly changes any non-exposed ores in the rock layer and sets itself to false when the configuration file is saved. If not specified, defaults to false.
===Database Connections===
::;DB_HOST:Use the specified directory for the database. This option is ignored if the server world directory is chosen through the GUI.
::;USE_LOGIN_DB:When true, uses a separate directory for the login database, otherwise uses the same database directory as DB_HOST. If not specified, defaults to false.
::;LOGIN_DB_HOST:Specifies the directory for the login database. This option is ignored unless USE_LOGIN_DB is true.
===Challenge and Epic===
::;CHALLENGEDAYS: Only used if STARTCHALLENGE is true. The number of days for the challenge timer to run. If not specified, defaults to 30.
::;STARTCHALLENGE: Sets the start and end timers on a challenge server, using the duration specified in CHALLENGEDAYS.
::;WEB_PATH: Certain data such as player ranking, battles and Valrei map entities are written to xml files. This config item specifies the path in which these file will be created.
===Multi-Server===
::;USE_INCOMING_RMI: When true, the server will listen and respond to incoming messages via Java Remote Method Invocation (RMI), which allows command execution and querying by external systems. If not specified, defaults to false. Note that this option should not be enabled without first securing the server host ports, and is not recommended that this be run on a multi-user host as RMI is not inherently secure.
::;IS_GAME_SERVER: When true, indicates that direct login is allowed on this server. It is possible to configure a cluster of servers such that one acts as a dedicated login server, in which case the login server would have this set to false while the others would be true. If not specified, defaults to true.
===Logging===
These settings control the mechanisms and amount of logging that is performed.
::;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.
::;USE_TILE_LOG: When true, logs tile event details to the database. If not specified, defaults to false.
===Maintenance/Diagnostics===
::;ANALYSE_ALL_DB_TABLES: When true, analyses database tables on startup. If not specified, defaults to false.
::;CHECK_WURMLOGS: When true, checks the logs database tables if and only if a database table maintenance task option (ANALYSE_ALL_DB_TABLES) is also true. This is usually a long running task. If not specified, defaults to false.
::;CRASHED: When true, players have their fatigue reset and are given full sleep bonus on startup. This setting is not automatic, and needs to be set to true or false manually. If not set, defaults to false.
::;MAINTAINING: When true, indicates that the server is running in maintenance mode, in which only players with power level > 0 may log in. If not specified, defaults to false.
::;PRUNEDB: If true, removes old players from the database. Players are removed only if all of the following hold:
:::*Player is power 0
:::*Playing time is less that one day
:::*The player last logged out at least three months ago
:::*Player payment expiry date is 0
::'''Note:''' If all the above hold and the player has more than 5 silvers in the bank, 5 silvers is deducted, last logout is set to current time and an email is sent warning of impending account deletion. If not specified, defaults to false.
===Advanced===
The following options are for advanced users only. Changing these may adversely affect your server and is not recommended for live servers without testing.
::;NUMBER_OF_DIRTY_MESH_ROWS_TO_SAVE_EACH_CALL: Number of terrain mesh rows to be saved each time the scheduled executor performs a save.
::;NUMBER_OF_DB_CREATURE_POSITIONS_TO_UPDATE_EACH_TIME: The number of creatures in the database to update each time the creature position updater runs. If not specified, defaults to 500.
::;NUMBER_OF_DB_ITEM_DAMAGES_TO_UPDATE_EACH_TIME: The number of items in the database to update each time the item damage upsdater runs. If not specified, defaults to 500.
::;NUMBER_OF_DB_PLAYER_POSITIONS_TO_UPDATE_EACH_TIME: The number of player positions to update each time the scheduled executor is called. If not specified, defaults to 500.
::;PLAYER_CONN_MILLIS: Number of milliseconds to wait between player connections. If not specified, defaults to 1000.
::;SCHEDULED_EXECUTOR_SERVICE_NUMBER_OF_THREADS: Specifies the number of threads to be allocated to the scheduled executor pool.
::;USE_SCHEDULED_EXECUTOR_TO_UPDATE_PLAYER_POSITION_IN_DATABASE: When true, use a scheduled executor to update player positions in the database instead of the main server thread. If not specified, defaults to false.
::;USE_SCHEDULED_EXECUTOR: When true, use a scheduled executor to write the MRTG logs instead of from the main server thread. If not specified, defaults to false.
::;USE_SCHEDULED_EXECUTOR_TO_COUNT_EGGS: When true, use a schedule executor to count eggs instead of the main server thread. If not specified, defaults to false.
::;USE_SCHEDULED_EXECUTOR_FOR_SERVER: When true, use a scheduled executor to run the Server thread. When false, uses a timer task. If not specified, defaults to false.
::;USE_SCHEDULED_EXECUTOR_TO_SEND_TIME_SYNC: When true, use a scheduled executor to send time sync commands instead of from the main server thread. If not specified, defaults to false.
::;USE_SCHEDULED_EXECUTOR_TO_SWITCH_FATIGUE: When true, use a scheduled executor to update player fatigue instead of in the main server thread. If not specified, defaults to false.
::;USE_SCHEDULED_EXECUTOR_TO_UPDATE_CREATURE_POSITION_IN_DATABASE: When true, use a schedule executor to update a creature's position in the database. If not specified, defaults to false.
::;USE_SCHEDULED_EXECUTOR_TO_UPDATE_ITEM_DAMAGE_IN_DATABASE: When true, use a scheduled executor to update an Item's damage in the database instead of the main server thread. If not specified, defaults to false.
::;USE_SCHEDULED_EXECUTOR_TO_UPDATE_TWITTER: When true, use a schedule executor to update twitter instead of the main server thread. If not specified, defaults to false.
::;USE_DIRECT_BYTE_BUFFERS_FOR_MESHIO: Use direct allocation for reading from and writing to the meshes. If not specified, defaults to false.
::;USE_MULTI_THREADED_BANK_POLLING: When true, multiple threads will be used to poll the banks. If not specified, defaults to false.
::;USE_SCHEDULED_EXECUTOR_TO_TICK_CALENDAR: When true, a scheduled executor is used to tick the calendar instead of the main server thread. If not specified, defaults to false.

===Reserved Options===
The following options are reserved for future and/or internal use and it is recommended that they be left as they are in the default configuration file:
::;CHECK_ALL_DB_TABLES
::;DB_DRIVER
::;DB_PASS
::;DB_PORT
::;DB_USER
::;DBPATH
::;DBSTATS
::;LOGIN_DB_DRIVER
::;LOGIN_DB_PASS
::;LOGIN_DB_PORT
::;LOGIN_DB_USER
::;PREPSTATEMENTS
::;RUNBATCH
::;SITE_DB_DRIVER
::;SITE_DB_HOST
::;SITE_DB_PASS
::;SITE_DB_PORT
::;SITE_DB_USER
::;TRACK_OPEN_DATABASE_RESOURCES
::;USE_POOLED_DB
::;USE_QUEUE_TO_SEND_DATA_TO_PLAYERS
::;USE_SITE_DB
::;USE_SPLIT_CREATURES_TABLE
::;USEDB

===Troubleshooting===
:;Server is not visible in the server browser: 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.

Server administration (Wurm Unlimited)

2015-10-24T03:34:42Z

Taufiq: /* Troubleshooting */ Added troubleshooting note for launcher crashing on windows 10 computers with touchscreen enabled.

<div style="float:right; padding: 10px;">__TOC__</div>
[[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 [[Wurm_Unlimited|Getting Started]] guide for running Wurm Unlimited with the bundled server.

==Installation==
===General Requirements===
====Network Configuration====
The following ports will need to be opened:
:;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: 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.

If your ports are opened on your system's firewall, you may need to have your router forward those ports to your local area IP address. Please refer to your router's manual or your ISP for information on configuring port forwarding on your router.

'''Read more:''' [https://support.steampowered.com/kb_article.php?ref=8571-GLVN-8711 Required Ports for Steam]

====Windows & Linux====
Please see the [[Wurm_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.
* [https://www.java.com/en/download/help/windows_manual_download.xml Windows]
* [https://docs.oracle.com/javase/8/docs/technotes/guides/install/linux_jdk.html Linux RPM]
* [http://www.webupd8.org/2012/09/install-oracle-java-8-in-ubuntu-via-ppa.html Ubuntu/Debian]

====Headless====
The Wurm Unlimited Dedicated Server may be run on a ''headless'' system. This means that the server may be started from the command line without a graphical interface. You will need to install [https://developer.valvesoftware.com/wiki/SteamCMD SteamCMD], from the instructions here: https://developer.valvesoftware.com/wiki/SteamCMD

* Headless mode is '''not''' officially supported by Code Club. The instructions provided have been tested on and are intended for an '''Ubuntu/Debian''' system.
* 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>.

==Running the Server==
===Windows===
You may run the server from within Steam, or by double-clicking the icon on your desktop. Alternatively you may run <tt>WurmServerLauncher.exe</tt> from the installation folder.

===Linux Headless===
The Standard Widget Toolkit for GTK+ Java library and a virtual frame buffer such as Xvfb will need to be installed:
sudo apt-get install libswt-gtk-3-java xvfb
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>

===Launcher Configuration===
Under most circumstances the server should run without needing customisation of its launch configuration. If necessary however, configuration of the server launcher may be done by editing the configuration file in the following location within your steam folder:
steamapps\common\Wurm Unlimited Dedicated Server\LaunchConfig.ini

This file contains the options for starting the Java runtime. To override the in-built runtime that is used, set the following options in the Runtime section (replace with your own Java path):
OverrideJavaRegEntry=true
JavaPath=C:\Program Files\Java\jdk1.8.0_60\jre\bin\server

==User Interface==
On launch, the server GUI should appear:

===Select Game Database===
::;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.
::;Seconds to shutdown: Controls the number of seconds to wait after the shutdown button is pressed before initiating shutdown.
::;Reason for shutdown: When shutdown is initiated, this is broadcast to players as the reason for the shutdown.
::;Shutdown server: Initiates server shutdown, as configured by the seconds to shutdown and reason for shutdown.
::;Modify the current selected database: These allow modification of the currently selected database. A database may be renamed, deleted, or copied under a new name.
===Local Server===
This controls aspects of the main server
====1. Server Settings====
::;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.
::;Server External IP Port: This is the port on which the server will communicate with clients.
::;Steam password: Servers may allow any Wurm Unlimited client to connect, or to restrict access to those with the required password. If set, players need to provide this in order to connect to your server.
::;Maximum number of players.: This sets the limit on the maximum number of players allowed at any one time. When the server reaches its maximum, no players will be able to connect until another has disconnected.
::;Allow PvP: Allows player-versus-player combat, building destruction and theft.
::;Epic settings: Turns on Epic mode, where skillgain is faster and missions affect Valrei.
::;Home server: A Home server can only have settlements from one kingdom.
::;Kingdom: For Home servers, this value indicates the kingdom to which the server belongs. Built-in kingdom values are:
:::*0 - No kingdom
:::*1 - Jenn-Kellon
:::*2 - Mol-Rehan
:::*3 - Horde of the Summoned
:::*4 - Freedom
::;Message of the day: A message to display upon login
====2. Advance Server Settings====
::;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.
::;RMI Port: This is the port over which Remote Method Invocation calls are made. RMI is not enabled unless USE_INCOMING_RMI is set to true in the configuration file.
::;Intra server password: When running multiple servers together, this is password is used for cross-server communication.
::;Login server: The login server is the central cluster node responsible for bank accounts and cross communication
::;Test server: Running as a test server turns on a number of additional settings and debug options.
::;Random spawn points: If set, new players with spawn in a randomised location unless a permanent kingdom village is set. If a server has spawn items in the world (eg. Soulstones), the spawn location will be based on one of these items chosen at random.
::;Spawnpoint x: Where players generally spawn, tile x.
::;Spawnpoint y: Where players generally spawn, tile y
::;Kingdom 2 spawnpoint x: Where kingdom 2 players spawn, tile x
::;Kingdom 2 spawnpoint y: Where kingdom 2 players spawn, tile y
::;Kingdom 3 spawnpoint x: Where kingdom 3 players spawn, tile x
::;Kingdom 3 spawnpoint y: Where kingdom 3 players spawn, tile y
:'''Note:''' If no spawn items exist, the location will be on a tile chosen at random in the world, providing it satisfies the following constraints:
::* Height greater than -1
::* Steepness < 20

====3. Gameplay Tweaks====
::;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
::;Mind Logic skill start value: Start value of Mind Logic Characteristic (used for controlling vehicles)
::;Body Control skill start value: Start value of Mind Logic Characteristic (used for controlling mounts)
::;Fight skill start value: Affects start value of the overall fighting skill
::;Overall skill start value: Start value of all other skills
::;Player combat rating modifier: Modifies player combat power versus creatures
::;Action speed multiplier: Divides the max standard time an action takes. Higher makes actions faster.
::;Hota Delay: The time in minutes between Hunt Of The Ancients rounds
::;Max Creatures: Maximum number of creatures in the world.
::;Aggressive Creatures: Approximate maximum percentage of aggressive creatures in the world.
::;Settlement upkeep enabled: If enabled, settlements require upkeep money. Once a settlement runs out of upkeep it is disbanded.
::;No deeding costs: If enabled, deeding is free and costs no money
::;Trader max money: The max amount of money a trader will receive from the pool
::;Trader initial money: The initial amount of money a trader will receive from the pool
::;Minimum mining hits required: The minimum number of times you need to mine before a wall disappears
::;Breeding time modifier: A modifier which makes breeding faster the higher it is.
::;Field growth timer, hour: The number hours between field growth checks
::;Money pool: This is the amount of money that will be in the money pool after server restart.
====4. Twitter Settings====
::;Consumer key: Twitter consumer key
::;Consumer secret: Twitter consumer secret
::;Application token: Twitter application token
::;Application secret: Twitter application secret
====5. Maintenance====
::;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===
====1. Server Settings====
::;Server Name: Name of the neighboring server.
::;Server ID:This number is a unique identifier for the server in a server cluster.
::;Server External IP Address: External IP of the neighboring server.
::;Server External IP Port: Port of the neighboring server.
::;Server Internal IP Address: This is the IP address that is used to communicate with other servers.
::;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.
::;RMI Port: This is the port over which Remote Method Invocation calls are made. RMI is not enabled unless USE_INCOMING_RMI is set to true in the configuration file.
::;Intra server password: When running multiple servers together, this is password is used for cross-server communication.
::;Login server: The login server is the central cluster node responsible for bank accounts and cross communication
===Server Travel===
::;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.
::;East: Drop-down box to select a server in the current cluster to transfer players to when they travel east.
::;West: Drop-down box to select a server in the current cluster to transfer players to when they travel west.
===Players===
This tab allows changes to specific players
::;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:
::;Player Name: The name of the player.
::;Position in X: The X position of the player.
::;Position in Y: The Y position of the player.
::'''Note''': These are ''real'' X and Y positions, not ''tile'' positions.
::;Player Game Management Power: A value that represents the player's current GM level.
:::* 0 - Normal Player. Cannot use any wands.
:::* 1 - Hero: Has limited abilities and can mostly move around invisible and teleport but not see character details or affect anything. They can be given a wand of teleportation to move around with.
:::* 2 - GM: Standard GM-level. This level and above can set players as CA or CM, move players, ban players, lookup player information etc. This level can use the '''ivory wand''' to invoke various GM powers.
:::* 3 - High God: A higher level than GM. There's no significant difference in power between a High God and a GM.
:::* 4 - Arch GM: High level GM that can spawn items and creatures, set skills, shutdown servers, and so on. This level can do nearly everything a level 5 can and has the ability to use the '''ebony wand''' as well as the '''ivory wand'''.
:::* 5 - Implementor: Highest level, very little difference from Arch GM.
::;Server ID of the player: The server ID where the player is currently located. Changing this to a bad value will make the player unable to log in.
::;Whether the player is undead: Allows the player to play as undead.

==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.
::;CREATESEEDS:If true, on startup the server will assign random forage/botanize resources to random tiles. If not specified, defaults to false.
::;PROSPECT:When true, randomly changes any non-exposed ores in the rock layer and sets itself to false when the configuration file is saved. If not specified, defaults to false.
===Database Connections===
::;DB_HOST:Use the specified directory for the database. This option is ignored if the server world directory is chosen through the GUI.
::;USE_LOGIN_DB:When true, uses a separate directory for the login database, otherwise uses the same database directory as DB_HOST. If not specified, defaults to false.
::;LOGIN_DB_HOST:Specifies the directory for the login database. This option is ignored unless USE_LOGIN_DB is true.
===Challenge and Epic===
::;CHALLENGEDAYS: Only used if STARTCHALLENGE is true. The number of days for the challenge timer to run. If not specified, defaults to 30.
::;STARTCHALLENGE: Sets the start and end timers on a challenge server, using the duration specified in CHALLENGEDAYS.
::;WEB_PATH: Certain data such as player ranking, battles and Valrei map entities are written to xml files. This config item specifies the path in which these file will be created.
===Multi-Server===
::;USE_INCOMING_RMI: When true, the server will listen and respond to incoming messages via Java Remote Method Invocation (RMI), which allows command execution and querying by external systems. If not specified, defaults to false. Note that this option should not be enabled without first securing the server host ports, and is not recommended that this be run on a multi-user host as RMI is not inherently secure.
::;IS_GAME_SERVER: When true, indicates that direct login is allowed on this server. It is possible to configure a cluster of servers such that one acts as a dedicated login server, in which case the login server would have this set to false while the others would be true. If not specified, defaults to true.
===Logging===
These settings control the mechanisms and amount of logging that is performed.
::;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.
::;USE_TILE_LOG: When true, logs tile event details to the database. If not specified, defaults to false.
===Maintenance/Diagnostics===
::;ANALYSE_ALL_DB_TABLES: When true, analyses database tables on startup. If not specified, defaults to false.
::;CHECK_WURMLOGS: When true, checks the logs database tables if and only if a database table maintenance task option (ANALYSE_ALL_DB_TABLES) is also true. This is usually a long running task. If not specified, defaults to false.
::;CRASHED: When true, players have their fatigue reset and are given full sleep bonus on startup. This setting is not automatic, and needs to be set to true or false manually. If not set, defaults to false.
::;MAINTAINING: When true, indicates that the server is running in maintenance mode, in which only players with power level > 0 may log in. If not specified, defaults to false.
::;PRUNEDB: If true, removes old players from the database. Players are removed only if all of the following hold:
:::*Player is power 0
:::*Playing time is less that one day
:::*The player last logged out at least three months ago
:::*Player payment expiry date is 0
::'''Note:''' If all the above hold and the player has more than 5 silvers in the bank, 5 silvers is deducted, last logout is set to current time and an email is sent warning of impending account deletion. If not specified, defaults to false.
===Advanced===
The following options are for advanced users only. Changing these may adversely affect your server and is not recommended for live servers without testing.
::;NUMBER_OF_DIRTY_MESH_ROWS_TO_SAVE_EACH_CALL: Number of terrain mesh rows to be saved each time the scheduled executor performs a save.
::;NUMBER_OF_DB_CREATURE_POSITIONS_TO_UPDATE_EACH_TIME: The number of creatures in the database to update each time the creature position updater runs. If not specified, defaults to 500.
::;NUMBER_OF_DB_ITEM_DAMAGES_TO_UPDATE_EACH_TIME: The number of items in the database to update each time the item damage upsdater runs. If not specified, defaults to 500.
::;NUMBER_OF_DB_PLAYER_POSITIONS_TO_UPDATE_EACH_TIME: The number of player positions to update each time the scheduled executor is called. If not specified, defaults to 500.
::;PLAYER_CONN_MILLIS: Number of milliseconds to wait between player connections. If not specified, defaults to 1000.
::;SCHEDULED_EXECUTOR_SERVICE_NUMBER_OF_THREADS: Specifies the number of threads to be allocated to the scheduled executor pool.
::;USE_SCHEDULED_EXECUTOR_TO_UPDATE_PLAYER_POSITION_IN_DATABASE: When true, use a scheduled executor to update player positions in the database instead of the main server thread. If not specified, defaults to false.
::;USE_SCHEDULED_EXECUTOR: When true, use a scheduled executor to write the MRTG logs instead of from the main server thread. If not specified, defaults to false.
::;USE_SCHEDULED_EXECUTOR_TO_COUNT_EGGS: When true, use a schedule executor to count eggs instead of the main server thread. If not specified, defaults to false.
::;USE_SCHEDULED_EXECUTOR_FOR_SERVER: When true, use a scheduled executor to run the Server thread. When false, uses a timer task. If not specified, defaults to false.
::;USE_SCHEDULED_EXECUTOR_TO_SEND_TIME_SYNC: When true, use a scheduled executor to send time sync commands instead of from the main server thread. If not specified, defaults to false.
::;USE_SCHEDULED_EXECUTOR_TO_SWITCH_FATIGUE: When true, use a scheduled executor to update player fatigue instead of in the main server thread. If not specified, defaults to false.
::;USE_SCHEDULED_EXECUTOR_TO_UPDATE_CREATURE_POSITION_IN_DATABASE: When true, use a schedule executor to update a creature's position in the database. If not specified, defaults to false.
::;USE_SCHEDULED_EXECUTOR_TO_UPDATE_ITEM_DAMAGE_IN_DATABASE: When true, use a scheduled executor to update an Item's damage in the database instead of the main server thread. If not specified, defaults to false.
::;USE_SCHEDULED_EXECUTOR_TO_UPDATE_TWITTER: When true, use a schedule executor to update twitter instead of the main server thread. If not specified, defaults to false.
::;USE_DIRECT_BYTE_BUFFERS_FOR_MESHIO: Use direct allocation for reading from and writing to the meshes. If not specified, defaults to false.
::;USE_MULTI_THREADED_BANK_POLLING: When true, multiple threads will be used to poll the banks. If not specified, defaults to false.
::;USE_SCHEDULED_EXECUTOR_TO_TICK_CALENDAR: When true, a scheduled executor is used to tick the calendar instead of the main server thread. If not specified, defaults to false.

===Reserved Options===
The following options are reserved for future and/or internal use and it is recommended that they be left as they are in the default configuration file:
::;CHECK_ALL_DB_TABLES
::;DB_DRIVER
::;DB_PASS
::;DB_PORT
::;DB_USER
::;DBPATH
::;DBSTATS
::;LOGIN_DB_DRIVER
::;LOGIN_DB_PASS
::;LOGIN_DB_PORT
::;LOGIN_DB_USER
::;PREPSTATEMENTS
::;RUNBATCH
::;SITE_DB_DRIVER
::;SITE_DB_HOST
::;SITE_DB_PASS
::;SITE_DB_PORT
::;SITE_DB_USER
::;TRACK_OPEN_DATABASE_RESOURCES
::;USE_POOLED_DB
::;USE_QUEUE_TO_SEND_DATA_TO_PLAYERS
::;USE_SITE_DB
::;USE_SPLIT_CREATURES_TABLE
::;USEDB

===Troubleshooting===
:;Server is not visible in the server browser: 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.

Server administration (Wurm Unlimited)

2015-10-23T23:46:41Z

Taufiq: /* Server Configuration file */ Added mention of config file syntax, added examples for PLAYERLOG configuration item.

<div style="float:right; padding: 10px;">__TOC__</div>
[[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 [[Wurm_Unlimited|Getting Started]] guide for running Wurm Unlimited with the bundled server.

==Installation==
===General Requirements===
====Network Configuration====
The following ports will need to be opened:
:;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: 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.

If your ports are opened on your system's firewall, you may need to have your router forward those ports to your local area IP address. Please refer to your router's manual or your ISP for information on configuring port forwarding on your router.

'''Read more:''' [https://support.steampowered.com/kb_article.php?ref=8571-GLVN-8711 Required Ports for Steam]

====Windows & Linux====
Please see the [[Wurm_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.
* [https://www.java.com/en/download/help/windows_manual_download.xml Windows]
* [https://docs.oracle.com/javase/8/docs/technotes/guides/install/linux_jdk.html Linux RPM]
* [http://www.webupd8.org/2012/09/install-oracle-java-8-in-ubuntu-via-ppa.html Ubuntu/Debian]

====Headless====
The Wurm Unlimited Dedicated Server may be run on a ''headless'' system. This means that the server may be started from the command line without a graphical interface. You will need to install [https://developer.valvesoftware.com/wiki/SteamCMD SteamCMD], from the instructions here: https://developer.valvesoftware.com/wiki/SteamCMD

* Headless mode is '''not''' officially supported by Code Club. The instructions provided have been tested on and are intended for an '''Ubuntu/Debian''' system.
* 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>.

==Running the Server==
===Windows===
You may run the server from within Steam, or by double-clicking the icon on your desktop. Alternatively you may run <tt>WurmServerLauncher.exe</tt> from the installation folder.

===Linux Headless===
The Standard Widget Toolkit for GTK+ Java library and a virtual frame buffer such as Xvfb will need to be installed:
sudo apt-get install libswt-gtk-3-java xvfb
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>

===Launcher Configuration===
Under most circumstances the server should run without needing customisation of its launch configuration. If necessary however, configuration of the server launcher may be done by editing the configuration file in the following location within your steam folder:
steamapps\common\Wurm Unlimited Dedicated Server\LaunchConfig.ini

This file contains the options for starting the Java runtime. To override the in-built runtime that is used, set the following options in the Runtime section (replace with your own Java path):
OverrideJavaRegEntry=true
JavaPath=C:\Program Files\Java\jdk1.8.0_60\jre\bin\server

==User Interface==
On launch, the server GUI should appear:

===Select Game Database===
::;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.
::;Seconds to shutdown: Controls the number of seconds to wait after the shutdown button is pressed before initiating shutdown.
::;Reason for shutdown: When shutdown is initiated, this is broadcast to players as the reason for the shutdown.
::;Shutdown server: Initiates server shutdown, as configured by the seconds to shutdown and reason for shutdown.
::;Modify the current selected database: These allow modification of the currently selected database. A database may be renamed, deleted, or copied under a new name.
===Local Server===
This controls aspects of the main server
====1. Server Settings====
::;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.
::;Server External IP Port: This is the port on which the server will communicate with clients.
::;Steam password: Servers may allow any Wurm Unlimited client to connect, or to restrict access to those with the required password. If set, players need to provide this in order to connect to your server.
::;Maximum number of players.: This sets the limit on the maximum number of players allowed at any one time. When the server reaches its maximum, no players will be able to connect until another has disconnected.
::;Allow PvP: Allows player-versus-player combat, building destruction and theft.
::;Epic settings: Turns on Epic mode, where skillgain is faster and missions affect Valrei.
::;Home server: A Home server can only have settlements from one kingdom.
::;Kingdom: For Home servers, this value indicates the kingdom to which the server belongs. Built-in kingdom values are:
:::*0 - No kingdom
:::*1 - Jenn-Kellon
:::*2 - Mol-Rehan
:::*3 - Horde of the Summoned
:::*4 - Freedom
::;Message of the day: A message to display upon login
====2. Advance Server Settings====
::;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.
::;RMI Port: This is the port over which Remote Method Invocation calls are made. RMI is not enabled unless USE_INCOMING_RMI is set to true in the configuration file.
::;Intra server password: When running multiple servers together, this is password is used for cross-server communication.
::;Login server: The login server is the central cluster node responsible for bank accounts and cross communication
::;Test server: Running as a test server turns on a number of additional settings and debug options.
::;Random spawn points: If set, new players with spawn in a randomised location unless a permanent kingdom village is set. If a server has spawn items in the world (eg. Soulstones), the spawn location will be based on one of these items chosen at random.
::;Spawnpoint x: Where players generally spawn, tile x.
::;Spawnpoint y: Where players generally spawn, tile y
::;Kingdom 2 spawnpoint x: Where kingdom 2 players spawn, tile x
::;Kingdom 2 spawnpoint y: Where kingdom 2 players spawn, tile y
::;Kingdom 3 spawnpoint x: Where kingdom 3 players spawn, tile x
::;Kingdom 3 spawnpoint y: Where kingdom 3 players spawn, tile y
:'''Note:''' If no spawn items exist, the location will be on a tile chosen at random in the world, providing it satisfies the following constraints:
::* Height greater than -1
::* Steepness < 20

====3. Gameplay Tweaks====
::;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
::;Mind Logic skill start value: Start value of Mind Logic Characteristic (used for controlling vehicles)
::;Body Control skill start value: Start value of Mind Logic Characteristic (used for controlling mounts)
::;Fight skill start value: Affects start value of the overall fighting skill
::;Overall skill start value: Start value of all other skills
::;Player combat rating modifier: Modifies player combat power versus creatures
::;Action speed multiplier: Divides the max standard time an action takes. Higher makes actions faster.
::;Hota Delay: The time in minutes between Hunt Of The Ancients rounds
::;Max Creatures: Maximum number of creatures in the world.
::;Aggressive Creatures: Approximate maximum percentage of aggressive creatures in the world.
::;Settlement upkeep enabled: If enabled, settlements require upkeep money. Once a settlement runs out of upkeep it is disbanded.
::;No deeding costs: If enabled, deeding is free and costs no money
::;Trader max money: The max amount of money a trader will receive from the pool
::;Trader initial money: The initial amount of money a trader will receive from the pool
::;Minimum mining hits required: The minimum number of times you need to mine before a wall disappears
::;Breeding time modifier: A modifier which makes breeding faster the higher it is.
::;Field growth timer, hour: The number hours between field growth checks
::;Money pool: This is the amount of money that will be in the money pool after server restart.
====4. Twitter Settings====
::;Consumer key: Twitter consumer key
::;Consumer secret: Twitter consumer secret
::;Application token: Twitter application token
::;Application secret: Twitter application secret
====5. Maintenance====
::;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===
====1. Server Settings====
::;Server Name: Name of the neighboring server.
::;Server ID:This number is a unique identifier for the server in a server cluster.
::;Server External IP Address: External IP of the neighboring server.
::;Server External IP Port: Port of the neighboring server.
::;Server Internal IP Address: This is the IP address that is used to communicate with other servers.
::;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.
::;RMI Port: This is the port over which Remote Method Invocation calls are made. RMI is not enabled unless USE_INCOMING_RMI is set to true in the configuration file.
::;Intra server password: When running multiple servers together, this is password is used for cross-server communication.
::;Login server: The login server is the central cluster node responsible for bank accounts and cross communication
===Server Travel===
::;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.
::;East: Drop-down box to select a server in the current cluster to transfer players to when they travel east.
::;West: Drop-down box to select a server in the current cluster to transfer players to when they travel west.
===Players===
This tab allows changes to specific players
::;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:
::;Player Name: The name of the player.
::;Position in X: The X position of the player.
::;Position in Y: The Y position of the player.
::'''Note''': These are ''real'' X and Y positions, not ''tile'' positions.
::;Player Game Management Power: A value that represents the player's current GM level.
:::* 0 - Normal Player. Cannot use any wands.
:::* 1 - Hero: Has limited abilities and can mostly move around invisible and teleport but not see character details or affect anything. They can be given a wand of teleportation to move around with.
:::* 2 - GM: Standard GM-level. This level and above can set players as CA or CM, move players, ban players, lookup player information etc. This level can use the '''ivory wand''' to invoke various GM powers.
:::* 3 - High God: A higher level than GM. There's no significant difference in power between a High God and a GM.
:::* 4 - Arch GM: High level GM that can spawn items and creatures, set skills, shutdown servers, and so on. This level can do nearly everything a level 5 can and has the ability to use the '''ebony wand''' as well as the '''ivory wand'''.
:::* 5 - Implementor: Highest level, very little difference from Arch GM.
::;Server ID of the player: The server ID where the player is currently located. Changing this to a bad value will make the player unable to log in.
::;Whether the player is undead: Allows the player to play as undead.

==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.
::;CREATESEEDS:If true, on startup the server will assign random forage/botanize resources to random tiles. If not specified, defaults to false.
::;PROSPECT:When true, randomly changes any non-exposed ores in the rock layer and sets itself to false when the configuration file is saved. If not specified, defaults to false.
===Database Connections===
::;DB_HOST:Use the specified directory for the database. This option is ignored if the server world directory is chosen through the GUI.
::;USE_LOGIN_DB:When true, uses a separate directory for the login database, otherwise uses the same database directory as DB_HOST. If not specified, defaults to false.
::;LOGIN_DB_HOST:Specifies the directory for the login database. This option is ignored unless USE_LOGIN_DB is true.
===Challenge and Epic===
::;CHALLENGEDAYS: Only used if STARTCHALLENGE is true. The number of days for the challenge timer to run. If not specified, defaults to 30.
::;STARTCHALLENGE: Sets the start and end timers on a challenge server, using the duration specified in CHALLENGEDAYS.
::;WEB_PATH: Certain data such as player ranking, battles and Valrei map entities are written to xml files. This config item specifies the path in which these file will be created.
===Multi-Server===
::;USE_INCOMING_RMI: When true, the server will listen and respond to incoming messages via Java Remote Method Invocation (RMI), which allows command execution and querying by external systems. If not specified, defaults to false. Note that this option should not be enabled without first securing the server host ports, and is not recommended that this be run on a multi-user host as RMI is not inherently secure.
::;IS_GAME_SERVER: When true, indicates that direct login is allowed on this server. It is possible to configure a cluster of servers such that one acts as a dedicated login server, in which case the login server would have this set to false while the others would be true. If not specified, defaults to true.
===Logging===
These settings control the mechanisms and amount of logging that is performed.
::;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.
::;USE_TILE_LOG: When true, logs tile event details to the database. If not specified, defaults to false.
===Maintenance/Diagnostics===
::;ANALYSE_ALL_DB_TABLES: When true, analyses database tables on startup. If not specified, defaults to false.
::;CHECK_WURMLOGS: When true, checks the logs database tables if and only if a database table maintenance task option (ANALYSE_ALL_DB_TABLES) is also true. This is usually a long running task. If not specified, defaults to false.
::;CRASHED: When true, players have their fatigue reset and are given full sleep bonus on startup. This setting is not automatic, and needs to be set to true or false manually. If not set, defaults to false.
::;MAINTAINING: When true, indicates that the server is running in maintenance mode, in which only players with power level > 0 may log in. If not specified, defaults to false.
::;PRUNEDB: If true, removes old players from the database. Players are removed only if all of the following hold:
:::*Player is power 0
:::*Playing time is less that one day
:::*The player last logged out at least three months ago
:::*Player payment expiry date is 0
::'''Note:''' If all the above hold and the player has more than 5 silvers in the bank, 5 silvers is deducted, last logout is set to current time and an email is sent warning of impending account deletion. If not specified, defaults to false.
===Advanced===
The following options are for advanced users only. Changing these may adversely affect your server and is not recommended for live servers without testing.
::;NUMBER_OF_DIRTY_MESH_ROWS_TO_SAVE_EACH_CALL: Number of terrain mesh rows to be saved each time the scheduled executor performs a save.
::;NUMBER_OF_DB_CREATURE_POSITIONS_TO_UPDATE_EACH_TIME: The number of creatures in the database to update each time the creature position updater runs. If not specified, defaults to 500.
::;NUMBER_OF_DB_ITEM_DAMAGES_TO_UPDATE_EACH_TIME: The number of items in the database to update each time the item damage upsdater runs. If not specified, defaults to 500.
::;NUMBER_OF_DB_PLAYER_POSITIONS_TO_UPDATE_EACH_TIME: The number of player positions to update each time the scheduled executor is called. If not specified, defaults to 500.
::;PLAYER_CONN_MILLIS: Number of milliseconds to wait between player connections. If not specified, defaults to 1000.
::;SCHEDULED_EXECUTOR_SERVICE_NUMBER_OF_THREADS: Specifies the number of threads to be allocated to the scheduled executor pool.
::;USE_SCHEDULED_EXECUTOR_TO_UPDATE_PLAYER_POSITION_IN_DATABASE: When true, use a scheduled executor to update player positions in the database instead of the main server thread. If not specified, defaults to false.
::;USE_SCHEDULED_EXECUTOR: When true, use a scheduled executor to write the MRTG logs instead of from the main server thread. If not specified, defaults to false.
::;USE_SCHEDULED_EXECUTOR_TO_COUNT_EGGS: When true, use a schedule executor to count eggs instead of the main server thread. If not specified, defaults to false.
::;USE_SCHEDULED_EXECUTOR_FOR_SERVER: When true, use a scheduled executor to run the Server thread. When false, uses a timer task. If not specified, defaults to false.
::;USE_SCHEDULED_EXECUTOR_TO_SEND_TIME_SYNC: When true, use a scheduled executor to send time sync commands instead of from the main server thread. If not specified, defaults to false.
::;USE_SCHEDULED_EXECUTOR_TO_SWITCH_FATIGUE: When true, use a scheduled executor to update player fatigue instead of in the main server thread. If not specified, defaults to false.
::;USE_SCHEDULED_EXECUTOR_TO_UPDATE_CREATURE_POSITION_IN_DATABASE: When true, use a schedule executor to update a creature's position in the database. If not specified, defaults to false.
::;USE_SCHEDULED_EXECUTOR_TO_UPDATE_ITEM_DAMAGE_IN_DATABASE: When true, use a scheduled executor to update an Item's damage in the database instead of the main server thread. If not specified, defaults to false.
::;USE_SCHEDULED_EXECUTOR_TO_UPDATE_TWITTER: When true, use a schedule executor to update twitter instead of the main server thread. If not specified, defaults to false.
::;USE_DIRECT_BYTE_BUFFERS_FOR_MESHIO: Use direct allocation for reading from and writing to the meshes. If not specified, defaults to false.
::;USE_MULTI_THREADED_BANK_POLLING: When true, multiple threads will be used to poll the banks. If not specified, defaults to false.
::;USE_SCHEDULED_EXECUTOR_TO_TICK_CALENDAR: When true, a scheduled executor is used to tick the calendar instead of the main server thread. If not specified, defaults to false.

===Reserved Options===
The following options are reserved for future and/or internal use and it is recommended that they be left as they are in the default configuration file:
::;CHECK_ALL_DB_TABLES
::;DB_DRIVER
::;DB_PASS
::;DB_PORT
::;DB_USER
::;DBPATH
::;DBSTATS
::;LOGIN_DB_DRIVER
::;LOGIN_DB_PASS
::;LOGIN_DB_PORT
::;LOGIN_DB_USER
::;PREPSTATEMENTS
::;RUNBATCH
::;SITE_DB_DRIVER
::;SITE_DB_HOST
::;SITE_DB_PASS
::;SITE_DB_PORT
::;SITE_DB_USER
::;TRACK_OPEN_DATABASE_RESOURCES
::;USE_POOLED_DB
::;USE_QUEUE_TO_SEND_DATA_TO_PLAYERS
::;USE_SITE_DB
::;USE_SPLIT_CREATURES_TABLE
::;USEDB

===Troubleshooting===
:;Server is not visible in the server browser: his 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: <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]

Dev

2015-09-17T13:29:16Z

Taufiq: /* Volunteers */ Updated Warlander, has access to server

{{disclaimer}}

==The founding developers==
Wurm Online was originally created by [[User:Rolf|Rolf Janssen]] (Rolf) and [[User:Notch|Markus Persson]] (Notch). Up until 2007 Notch and Rolf continued to work together on the game; developing the client and server sides respectively. In 2007 Notch retired, but Rolf continued working on the game and created the Client Development Team to continue improving the client.

==What do developers do?==
Developers are responsible for a vast array of things from fixing bugs to creating graphics, maintaining the website, managing sysadmin and much more. They directly affect the game by making changes to code, adding content, and altering how things work.

=== Employed developers ===
* '''[[User:Rolf|Rolf]] - Owner & Database and Server developer'''
* Erikn - Server developer
* Haradur - Client developer
* Wox - Art Developer
* Saroman - Art Developer
* MaxC/Maximusi - Game Server Admin

=== Volunteers ===
* [[User:Budda|Budda]] - Server Developer, Client Developer
* [[User:Wollschaf|Wollschaf]] - Client Developer
* [https://twitter.com/saythebwurm saytheb] - Client Developer
* [[User:Darkfilo|Darkfilo]] - Client Developer
* Taufiq - Server Developer, Client Developer
* [[User:Egal|Egal]] - Server admin, Server Developer, Client Developer
* [[User:Zcul|Zcul]] a.k.a. Andreas - Server Developer, Client Developer
* Tich - Server Developer
* Heroic - Client Developer
* Anshar - Client Developer
* [[User:Warlander|Warlander]] - Server Developer, Client Developer
* Brqqq - Server Developer, Client Developer

=== Retired developers, Thanks guys! ===
* '''[[User:Notch|Notch]] - Founder / Client programmer'''
* DragonM - Coordinator, client development team
* Jake Lear - Artist
* Inventor - Artist
* Ron Smits - Server programmer
* [[User:Mortimar|Mortimar]] - Content Manager / Graphics
* Mrbloodworth - Lead Art developer
* [[User:Kilean|Kilean]] a.k.a Haraldstern - Client programmer
* Athero - Art developer
* Taliesin a.k.a [[User:Doughboy|Doughboy]] - Sound Developer
* [[User:Wintermute|Wintermute]] - Client developer
* Cryptik - Client Developer
* [[User:Kinoss|Kinoss]] - Art Developer
* [[User:Gurubear|Gurubear]] - Webmaster and Music
* Faeran - Sound developer, created Wurm video.
* Snowtech - Client developer
* Dashiva - Lead client development
* [[User:Dipse|Dipse]] - Client Developer
* Redbaron_Johan - PR / Marketing

== See also ... ==
* [http://forum.wurmonline.com/index.php?/topic/65947-some-nice-recruitments/ Rolf's blog post fo 2012-08-22]

{{WurmStaff}}

[[Category:Babel/D]]

Dev

2015-09-17T10:06:06Z

Taufiq: /* Volunteers */

{{disclaimer}}

==The founding developers==
Wurm Online was originally created by [[User:Rolf|Rolf Janssen]] (Rolf) and [[User:Notch|Markus Persson]] (Notch). Up until 2007 Notch and Rolf continued to work together on the game; developing the client and server sides respectively. In 2007 Notch retired, but Rolf continued working on the game and created the Client Development Team to continue improving the client.

==What do developers do?==
Developers are responsible for a vast array of things from fixing bugs to creating graphics, maintaining the website, managing sysadmin and much more. They directly affect the game by making changes to code, adding content, and altering how things work.

=== Employed developers ===
* '''[[User:Rolf|Rolf]] - Owner & Database and Server developer'''
* Erikn - Server developer
* Haradur - Client developer
* Wox - Art Developer
* Saroman - Art Developer
* MaxC/Maximusi - Game Server Admin

=== Volunteers ===
* [[User:Budda|Budda]] - Server Developer, Client Developer
* [[User:Wollschaf|Wollschaf]] - Client Developer
* [https://twitter.com/saythebwurm saytheb] - Client Developer
* [[User:Darkfilo|Darkfilo]] - Client Developer
* Taufiq - Server developer, Client developer
* [[User:Egal|Egal]] - Server admin, Server Developer, Client Developer
* [[User:Zcul|Zcul]] a.k.a. Andreas - Server Developer, Client Developer
* Tich - Server developer
* Heroic - Client developer
* Anshar - Client developer
* [[User:Warlander|Warlander]] - Client developer
* Brqqq - Server developer, Client developer

=== Retired developers, Thanks guys! ===
* '''[[User:Notch|Notch]] - Founder / Client programmer'''
* DragonM - Coordinator, client development team
* Jake Lear - Artist
* Inventor - Artist
* Ron Smits - Server programmer
* [[User:Mortimar|Mortimar]] - Content Manager / Graphics
* Mrbloodworth - Lead Art developer
* [[User:Kilean|Kilean]] a.k.a Haraldstern - Client programmer
* Athero - Art developer
* Taliesin a.k.a [[User:Doughboy|Doughboy]] - Sound Developer
* [[User:Wintermute|Wintermute]] - Client developer
* Cryptik - Client Developer
* [[User:Kinoss|Kinoss]] - Art Developer
* [[User:Gurubear|Gurubear]] - Webmaster and Music
* Faeran - Sound developer, created Wurm video.
* Snowtech - Client developer
* Dashiva - Lead client development
* [[User:Dipse|Dipse]] - Client Developer
* Redbaron_Johan - PR / Marketing

== See also ... ==
* [http://forum.wurmonline.com/index.php?/topic/65947-some-nice-recruitments/ Rolf's blog post fo 2012-08-22]

{{WurmStaff}}

[[Category:Babel/D]]

Player status effect

2014-11-18T01:19:32Z

Taufiq: Added Intellect of the Enlightened

A '''player status effect''' is the individual condition a [[player]] is assigned based on his/her interactions with the physical world. These range from conditions to do with [[hunger]], to [[Category:Buff spells|buffs]] from potions or trinkets, to debuffs from [[wound]]s sustained by [[fighting]] or recent activities. These statuses show on the bottom of the [[event window]], and since the 1.2 patch, as icons in a new window at the top right of the screen. The known statuses are as follows:

{| class="wikitable sortable" border="0" cellpadding="3"
|-
! Status !! Description
|-
| Defensive || When player is in [[defensive fighting]] mode. Increases parry and dodge rate but lowers hit damage.
|-
| Aggressive || When player is in [[aggressive fighting]] mode. Increases damage but lowers dodge and parry rate.
|-
| [[Diseased]] || Can occur after contact with diseased animals or players. Its effect is not known, but will go away with time.
|-
| Dry || Below 7.5% [[water]]. Thirst greatly reduces [[stamina]] regeneration rate.
|-
| Energetic || Appears when player has more than 90% stamina.
|-
| Exhausted || 0% stamina. Movement slows to a crawl below 2% stamina. Greatly reduced hit/parry/evasion chance if fighting with this condition.
|-
| [[Faithful]] || While player is faithful unable to perform actions player's [[god]] does not like. Can be toggled with the "Faithful" button on the event window.
|-
| [[Lawful]] || While lawful player unable to perform any illegal acts such as [[theft]]. Can be toggled with the "Lawful" button on the event window.
|-
| Full || Above 85% food. Having this status will slowly increase player's [[fat]] level.
|-
| [[Hunger|Hungry]] || Below 30% food. Slowed stamina regeneration rate.
|-
| Hurting || Triggered when player takes [[damage]] through fighting, falling, or some other [[injury]]. Lowers walking speed and is suspected to give a slight attack speed debuff.
|-
| [[Path of Knowledge#Intellect_of_the_Enlightened|Intellect of the Enlightened]] || "All skillgains are permanently increased by 25%, with the exception of Fighting skill." - [[Path of Knowledge#Intellect_of_the_Enlightened|Path of Knowledge level 11 perk]].
|-
| Parched || 0% water. Thirst greatly reduces stamina regeneration rate.
|-
| Sharp || Triggered from drinking a [[potion]]. Increases [[combat rating]] for 30 seconds.
|-
| [[Thirst|Thirsty]] || Below 30% water. Thirst greatly reduces stamina regeneration rate.
|-
| Tired || Below 30% stamina.
|-
| Unstoppable || Triggered from using a [[Farwalker amulet]] or sometimes [[praying]]. Gives a huge speed increase and renders the player immune to fall damage for a short period of time. Also removes walking speed debuff from hurting.
|-
| Weak || Below 15% stamina.
|-
| Faith Bonus* || Increases when in your god or god types domain. Max at 55 when near an altar of your god. Give better casts.
|-
| Spirit Favor* || Increased favor gain (unconfirmed). Gained from Completion of epic missions. Effects all followers of the affected god. (see [[Talk:Player_status_effect]])
|-
| Spirit Speed* || "Spirit Speed is a beneficial effect caused by religion" - Unknown effect
|-
| No skill loss || "You will not lose any skill in non-combat skills when dying" - [[Path of Knowledge#No skill loss|Path of Knowledge level 9 perk]].
|-
| Stamina of the Vibrant Light || "Reduces stamina loss by 50%" - [[Path of Power#Stamina of the Vibrant Light|Path of Power level 11 passive ability]].
|}

'* these are spell or religion effects

''There are several status effects known to give bonuses (such as the Kingdom fighting bonus) without showing in status effects. Temporary status effects from gained from spells cast upon you will appear in the Spell Effects section of the skill window.

==See also==
* [[User:Dashiva/Hunger]], effects of hunger, thirst, and stamina
* [[Spell effects]]

[[Category:Babel/P]]
[[Category:Player]]

Whetstone

2014-10-26T23:56:21Z

Taufiq: Removed gift box reference, as gift boxes are no longer able to be created

[[CDB|Main]] / [[Skills]] / [[Masonry]] / [[Stone cutting]] / '''{{PAGENAME}}'''

{{Item
|name=Whetstone
|image=Whetstone.png
|active=[[stone chisel]]
|passive=[[rock shards]] (0.33 kg)
|group=Tools
|materials=no
|result=* '''{{PAGENAME}}''' (0.30 kg)
|skill=stone cutting
|improve=no}}

== Description ==

''A small finely polished stone used for sharpening the edges of weapons.''

== Notes ==
* Whetstones decay very rapidly so they should always be stored in inventory.
* They cannot be repaired (though damage can be removed from them with the help of the spell [[Mend]].
* Max quality of the finished whetstone is determined by the quality of the [[rock shard]] used. Try to use as high quality a shard as possible, however it's no big loss to just make a new one later on as they need very little source material.
* .03kg of material is lost on a failed creation attempt.

[[Category:Stone cutting items]]
[[Category:Babel/W]]
[[Category:Tools]]

Small mast

2014-10-26T23:53:24Z

Taufiq: Removed gift box reference, as gift boxes are no longer able to be created

[[CDB|Main]] / [[Skills]] / [[Carpentry]] / [[Ship building]] / '''{{PAGENAME}}'''

{{Item
|name=Small mast
|image=Small mast.png
|active=[[hatchet]]
|passive=[[felled tree]] (72.00 kg)
|group=Shipbuilding resources
|materials=* None
|result=* 1 '''{{PAGENAME}}''' (60.00 kg)
* 1 [[wood scrap]] (12.00 kg)
|skill=ship building
|improve=carpentry
}}

== Description ==
''A rather small mast for a rig.''

== Notes ==
*Hatchet [[quality]] considerably affects success chance when creating.
*Can't be crafted with regular [[:Category:Axes|axes]], albeit you can chop up [[tree]]s.

== Used for ==
*[[Triangular rig]]
*[[Spinnaker rig]]

[[Category:Shipbuilding resources]]
[[Category:Babel/S]]

Medium mast

2014-10-26T23:52:45Z

Taufiq: Removed gift box reference, as gift boxes are no longer able to be created

[[CDB|Main]] / [[Skills]] / [[Carpentry]] / [[Ship building]] / '''{{PAGENAME}}'''

{{Item
|name=Medium mast
|image=Medium mast.png
|active=[[hatchet]]
|passive=[[felled tree]] (96.00 kg)
|group=Shipbuilding resources
|materials=* None
|result=* 1 '''{{PAGENAME}}''' (80.00 kg)
* 1 [[wood scrap]] (16.00 kg)
|skill=ship building
|improve=carpentry
}}

== Description ==
''A standard mast for a rig.''

== Used for ==
*[[Square rig]]

[[Category:Shipbuilding resources]]
[[Category:Babel/M]]

Guides:Build house

2014-10-16T02:32:19Z

Taufiq: /* Building the house */ Made the multi-storey section more obvious to those skimming the page.

[[Main Page]] / [[Useful links for beginners]] / '''The "how do I build a house?" guide'''

== Introduction ==

One of the first questions asked in the kingdom chat is "How can I build a house?". The answer is quite long, so a guide has been set up to help new players, which is here. This guide should provide the information you need to construct a house. If you are new then before you decide to build you may want to make sure you have properly planned your location and other things, in order to avoid unneeded frustration. See [[House Planning Guide]].

To construct your house, you will need:
* A [[Digging|flat]] area of ground.
* A [[mallet]] or an [[Iron Hammer|iron hammer]] (Higher Quality = faster build)
* 20 [[planks]] for each wall you build.
* 1 [[Large Nails|large nail]] for each wall you build.

This house would now be classed as "finished" and would be secure, but it does not have a '''floor''' and '''roof'''. To make these (from wood as it is easiest) you will need:
* The mallet or hammer you made the walls with.
* 4 [[small nails]] for the roof and floor.
* 10 [[planks]] for the floor.
* 10 [[wood shingle|wood shingles]] for the roof (they are made from planks, an extra 3 planks will be plenty.)

The largest house you can build is determined by how much [[carpentry|Carpentry]] skill you have. To find the amount of skill you need to build a certain house add the total number of floor tiles and the total number of walls. This formula is a useful one to use:

<center>''(total number of floor tiles) + (total number of wall sections) = carpentry skill required''</center>

So for a 2x2 house you would need:

<center>''(4 floor tiles) + (8 wall sections) = carpentry skill of 12''</center>

Symmetrical doughnut house formula where x is the the number of tiles that make up one side of the doughnut hole:
<center>(12 * x) + 12</center>

Helpful tools can be found in the External Tools section towards the bottom of this page.

If you are in a [[village]], you may be able to persuade someone with high carpentry skill to plan your house and then hand over the [[writ]].

== Finding a Location ==

When you think you are ready to make your first house, the first thing you are going to need is a suitable place to do so. Bear in mind that you will want some basic resources nearby such as water, trees, and exposed rock for making a mine tunnel.

Now that you have wandered around a little, if you believe you have found "The Spot" take a moment to check your local chat for other people. If no one is around, try to check around at least 30 tiles in every direction for existing houses and settlements. If you do find some sign of a settlement it is considered proper etiquette to contact the owner before beginning construction. While the established player does not own anything outside their deeded area, building on someone's doorstep is considered very rude. Normally, an established player will ask you to not build close, and may guide you to a location that is just as nice or better nearby. A good relationship with your neighbours improves everyone's experience in Wurm, and helps avoid misunderstandings.

For towns, however, it is considered to be rude to build with 50 to 100 tiles of the town if you do not have the permission of said town. Doing so can cause conflict and even hostility from a large group of players. It is always best to seek permission, and if declined, do not worry, there are more places to settle.

<b>Note: You cannot build a house inside the [[Settlement#Perimeter|perimeter]] of a [[settlement]] you are not a member of.</b> Although you can build a fence, it is considered very rude to do so without the consent of the settlement owner. [[Examine|Examining]] the ground tiles before you even start cutting down trees and levelling the ground will prevent further disappointment on your side and bad relations with your neighbours. It will say "This is within the perimeter of Settlement X" in the event window.

== Flattening the ground ==

After you find a suitable location you normally need to prepare the area. Before you plan your house the ground needs to be completely flat. In order to flatten the ground, "activate" your [[shovel]] by double clicking on it, then right click on the ground where you want the house. This should display a menu with a Flatten option. Select flatten and you will do just that. Note that flattening affects the eight tiles around the tile you flatten. If you do not have enough skill to flatten the exact spot you can dig dirt from nearby and drop it on the tiles to bring it closer to level. See also [[digging]].

== Woodcutting ==

For the [[planks]] and [[mallet]] you'll need to get some lumber - this is easy - activate your [[:Category:axes | axe]] and go to the nearest [[:Category:Trees|tree]]. It's a good idea to right click the tree and "examine" it before you decide to chop it down, as only very old trees will provide a good amount of lumber. When you have found a tree that you are happy with, simply right click it while your axe is activated and choose "cut down". You will need to do this multiple times before the tree is felled. Once it does fall you will see a felled tree on the ground (or just a log if the weight of the tree was below or exactly 24kg). Next you will need to chop up your felled tree in smaller pieces and thus create logs. Right click on the felled tree while you have your axe activated and select "chop up", now pick up the log and we will go on to planking and creating the mallet.

== Creating planks ==
Planking is just as simple as any other action in Wurm, which is lucky since you will need a lot of planks to build your house, 20 for every wall actually. To make planks you activate your saw (starting to see the logic yet?) and right click on your log, choose "create" and then "weapons" and "plank" in the sub-menu of create (plank being in the sub-menu of weapons). Planks can be failed when you try to create them, be patient with this because it will happen a lot - it's completely normal. Repeat the log cutting and plank-making to create the amount of planks you need for the amount of walls you have.

== Creating the mallet ==
Equip your [[Carving Knife]], right click the [[Log]] in your [[inventory]] and select Create/Weapons/Shaft. Do this twice. Then right click one of the [[shaft]] in your [[inventory]] and select Create/Miscellaneous/Mallet Head. Equip the [[Mallet Head]] and right-click the shaft, and select Create/Tools/Mallet. If all succeeded, you now have either a mallet or an unfinished mallet. If you have an unfinished one, you can try finishing it (examine it to see what it needs) or create a new one. There's a 20% chance that you'll create an unfinished one.

== Iron ==
Next up is [[iron lump|iron]], this is the hardest part.

To find iron activate your pickaxe, right click on a tile that says "rock" and choose "prospect" from the "mining" sub-menu. Iron is the most commonly occurring ore in Wurm, but it can be a challenge to find. You may have to search through a lot of rock tiles before you manage to find an iron mine - but [[prospecting]] can help narrow down your search.

'''If you are unlucky with finding an [[Iron Vein|iron vein]]''' you can also [[Foraging|rummage]] many rock tiles and collect the [[iron rock]]s which weigh 3kg and give 0.2kg of iron when melted. This is not much but may be enough to make the nails needed for building the house. This method is very useful for those without a public mine to use, or those who do not want to start a mine. You can easily get enough iron for your entire house, but it will be low quality nails.
This way can also be alot faster if you only need a low amount of iron and have many rock tiles around but no premade mine or luck with [[prospecting]] any iron.

[[Prospecting]] for Iron. When you prospect a rock tile it show all ore veins within a 7x7 area, you can use this to approximate the location of the ever elusive [[Iron Vein]]. Once you get the message there is iron nearby you can start to tunnel for it. The first rock tile will break after mining it approximately 60 times, all further tiles inside the cave take around 50. After your two tiles in you can start mining at different angles (up, forward, or down). Only the last action will decide which angle the mined tile will be, so once you receive the message 'the wall will break soon' start mining up, mining down or mining forward. There are many methods of building a cave, one of the most thorough method is to make your main shaft about 10 tiles long, then mine side shafts every other tile going in both directions.

When you have found your precious [[Iron Vein|iron vein]], it's time to start mining it to get to the ore. The "mine" option is also found in the "mining" sub-menu. Each mining action will deliver 20kg ore. You'll want to get to the iron inside the rock of these ores so you will have to smelt them. You do this by getting yourself another of those fancy logs and with your axe "create" a [[kindling]] from it. Once you have this little nifty piece of wood you select your steel and flint, right click on the kindling and create a [[campfire]] with it (its under the container sub-menu). Now that you have your camp-fire its time to get smelting! Right click on your camp-fire and "open" it, drag the ore from your inventory to the camp-fires inventory. Next there's waiting - lots of it. <em>MAKE SURE TO FEED THE FIRE WITH WOOD, OTHERWISE THE FLAMES WILL GO OUT AND YOU WILL HAVE TO START THE SMELTING PROCESS OVER FROM SCRATCH!</em> I suggest you mine more ore while you do this but of course if you want to idle you can do that too. Right click on the ore and examine it to check how hot it is, once it reaches "glowing hot" you are very close to get your [[Iron Lump]]. When the ore has smelted it is replaced by a 1kg [[Iron Lump]] in the camp-fire, you will need at least 2kg for the next step.

== Iron Anvil ==
The [[Small Anvil]] is a crucial tool in Wurm and this is what you will create now. Get your 2x1.0kg [[Iron Lump]] from the camp-fire, (they have to be glowing hot for this to work) and activate one of them, right click on the other and choose combine. Activate the mallet you made earlier and right click on the 2kg [[Iron Lump]], again choose create and pick iron anvil. If you are lucky you will pull this off at the first try, so just repeat until you have your anvil.

== Nails ==
Nails! This is what you need to keep your house together, large iron nails. Pick up a [[Iron Lump]] of at least 0.3kg and activate it, right click on your anvil and create, tools, large iron nails. When you succeed with this you will get a handful of [[Large Nails]], you'll need one of these handfuls per wall of your house. You'll also need 2 [[small nails]] for the floor and one [[small nails]] for the roof.

== Planning the house ==
For every tile your house will occupy, you'll need 1 carpentry skill. Also, for every wall you'll have you'll need 1 carpentry skill. So if you want to build a 1x1 house (the smallest house possible), you'll need 5 carpentry (4 walls, and 1 tile). To plan the house, go to your flattened piece of land, activate your mallet and right-click a tile, and select 'Plan building'. You can plan additional (adjacent) tiles in the same way; selecting 'Plan building' on a planned tile will remove it from the plan. When you're satisfied with your building shape, right click on it and select 'Finalize building'.

(to be able to plan more than 1 house, you either have to wait for server reset, or finish the first floor walls of the current plan)

== Building the house ==
Finally we can start to actually build the house. Activate your mallet and make sure you have at least one handful of large nails and a plank in your inventory, right click on a side of your house and select build, pick door, wall or window after your choice (remember that you need a door to be able to enter the house though) repeat this on all the walls, but don't move while attaching the planks or you will lose one of the planks (because you will stop creating as soon as you move and you attach the plank 1 second into the action).

Next you will have to pick up more planks and continue to build, 19 more times on every wall to be exact since they all need 20 planks total.

The majority of the work is now over. You now need to add a roof and a floor to your house. Right-click the ground with your mallet activated and click "plan floor," then right-click the ground again and click "plan roof." Then right-click each plan with your mallet activated and plan a type of floor and roof. A [[Wooden plank floor|Wooden Plank Floor]] is probably easiest along with a [[Wood shingle roof|Wood Shingle Roof.]] You'll need 3 [[Small Nails|Small Nails]] and about 15 [[planks|planks]] (some of which will need to be carved into [[wood shingle|wood shingles]] to complete both the floor and the roof.

When all this is done so is your house, w00t! {{smiley}}

=== Inner walls ===
Inner walls can only be planned once all the exterior walls of a house are complete. To plan inner walls activate a [[mallet]] or [[trowel]], right-click a tile border inside the house and select ''Plan'' > ''Inner wall''. On the wall plan select a wall type and continue as explained above.

Note: Only the owner of the house writ can add inner walls, and they require 30 Carpentry skill to plan (and possibly to also build).

=== Multi-storey housing ===

Your house is now complete with a roof, floor and finished walls. It's probably quite simple; but when you're a more skilled player you could make something much better, fancier and with more than one floor! See [[Multi-story housing|multi-story housing]] for more information.

== Repairing your house ==
Your house walls may become damaged in time by decay, or can be damaged by someone trying to break into your house (except on Freedom servers). To see the damage on one of your walls, right click the wall and select examine. This will display [[quality]] and [[damage]] of the wall.

To repair your house walls, activate a [[plank]], right-click your house wall, and select '''repair'''.

== Improving your house ==
The higher the [[quality]] of your walls, the slower they [[decay]], and the harder it is to break them for an attacker. To see the quality of one of your walls, right click the wall and select examine. This will display [[quality]] and [[damage]] of the wall.

'''Tip:''' To improve your house walls, activate a [[Plank]], right-click your house wall, and select '''Improve'''. Success and amount of improvement depends on your [[carpentry]] skill.

== Managing your Writ and Securing your Home ==

A [[Writ of Ownership]] will appear in your [[inventory]] the moment you click 'Finalize Building'. Writs are used to control who has access to your home or building, to lock or unlock all doors with a [[door lock]] on them, to change the name of the building, or to destroy the whole structure (and the writ with it). Just right-click the writ and select 'Manage'. Add other players to your friend list, and they will appear on your writ management screen. To allow access, simply select them as guests. :) Writ also acts as a key for all the doors on your building.

'''No player can pick up items from a finished house without being added as a guest on the writ of the building. Any player can get inside a finished house (but not pick anything up) unless relevant doors are locked with a [[door lock|door lock.]]'''

Writs cannot be dropped, even if you die, but can be [[trade]]d to another player.

== [[Stone house]]s ==

It's possible to build a house made of stone following the guide above ([[Account Types|premium players]] only), however the material requirements are different :

*Skill requirement : 30 [[Masonry]].
*[[Trowel]] for building the stone walls.
*20 x [[Stone Brick]] for each segment of wall.
*20 x [[Mortar]] for each segment of wall.
*10 x [[Stone Brick]] + 10 x [[Mortar]] for each floor segment (if you're doing a [[Stone brick floor]])

Basically once you have planned the layout of your structure you activate the [[Trowel|iron trowel]] and start building the walls. It is even possible to mix stone and wooden walls in the same house (based on which tool you start the wall with).

== External Tools ==

*[http://webdepp.sense-net.at/~toni/wurm/housecalc.php Web-based Calculator by Toni]
*[http://forum.wurmonline.com/index.php?/topic/75908-new-house-calculator/ Windows / Java Web Applet Calculator by Warlander] which supports doughnut and multi-floor houses

[[Category:Guides]]
[[Category:Babel/H]]

Console

2014-09-25T01:39:22Z

Taufiq: Added toolbelt commands

[[Main Page]] / '''{{PAGENAME}}'''

The '''console''' is a window for entering text commands to the [[Wurm]] [[client]]. It can be opened using {{key|F1}} in the default key bindings ({{key|F9}} in the current unstable client). Console commands should not be confused with [[chat commands]] or [[action]]s.

== Commands ==

Legend: <name> is a mandatory argument, [name] is an optional argument, (name|other) is an argument which requires one of the listed values.

; bind <key> : Shows the current binding for the given key.
; bind <key> "" : Removes the current binding for the given key.
; bind <key> <action> : Binds the key to the specified action. See [[key bindings]] for more information on <key> and <action> values.
; bind <key> "<text>" : Binds the key to a console command. Pressing the key will act as if you had typed the text into the console. See [[key bindings]] for more information.
; dump (debug | skills) : Saves the specified data to a file in the [[player]]'s dumps directory.
; dump (binds | options) : Dumps the specified data to the console.
; exec <filename> : Executes each line in the file as a console command.
; irc [server] [port] : Connects to the specified [[IRC]] network. Defaults are irc.rizon.net and 6667. <br> If the defaults are used, the client also autoconnects to #wurm
; ircsay <text> : Sends the text to the topmost IRC window.
; loadtoolbelt <0-9> : Loads the toolbelt of the specified number.
; nexttoolbelt : Loads the next toolbelt.
; prevtoolbelt : Loads the previous toolbelt.
; quit : Opens the quit dialog
; reallyquit : Quits the client without asking for confirmation
; refresh: Reloads the game graphics
; resize (fullscreen | maximized | windowed | resizable) width height [refreshrate] : Changes the window mode and resolution.
; savetoolbelt <0-9> : Saves the current toolbelt in the specified toolbelt configuration.
; say <text> : Sends the specified text to the local chat window. (Access other chat windows using /tell, /shout, /village)
; screenshot : Creates a screenshot (in the player's screenshot directory)
; sensitivity <0-10> : Changes mouse sensitivity to the given value. Note that this only changes the senstivity when looking around.
; setoption <string> : Displays a list of options whose name matches the string.
; setoption <option_name> <option_value> : Changes a game option without restarting. Not all options can be changed while playing. Look in gamesettings.txt for option names and value hints.
; settoolbelt <objectid> <slotid> : Set toolbelt slot. Item ids can be determined via looking into the ''"playerdata.txt"'' file after you log off.
; timelapse <seconds> : Starts taking screenshots automatically at every interval that you inputted with <seconds>. Type timelapse in the console and hit enter to turn the timelapse off.
; toggle ( [[compass]]* | console | debug | fightspam | [[friend|friends]] | gui | health | improve | inventory | mainmenu | menubar | mouselook | selected | skills | spelleffects | stats | target | [[toolbelt]]* | wikisearch*) : Toggles the specified feature. Most control display of [[HUD]] components.
; wiki <title> : Opens a window with the specified wiki page.

[[Category:Technical Details]]
[[Category:Babel/C]]