Voxel Turf Server GuideThis guide covers the basics of installing a server, creating a map and running the server via command line. To get help with command line options, run client.exe --help, or server.exe --help (windows), or vtclient --help or vtserver --help (linux) to get the command line switches.
InstallationLinux On a fresh Ubunutu 14.04 distribution, simply download the game, untar to any convient directory, and run install.sh (without superuser privilges). It will automatically detect if any packages are not present, and prompt you to install them. The game will be installed to the usual location, ~/.turf/, and the aliases vtclient and vtserver will be created. You may have to restart bash/your ssh session to be able to use them.
If you are using a different distro, have a look at install.sh for ideas for manual installation. The important thing is that Voxel Turf is installed to ~/.turf/, as this is where the client and server executables look for files.
Windows Run the installer, Voxel Turf will be installed to the usual location %HOME_DRIVE%\Program Files\Voxel Turf
Running The ServerThis guide assumes that you are running linux, and the alias vtserver points to ~/.turf/server. If you are running windows, instead run %HOME_DRIVE%\Program Files\server.exe
Automatic Command Generation When you start a server from the client (using Host Server from the Main Menu), the arguments used to run the server are written to logs/startserver.log. You can use this to generate command line instructions.
Example: You load a save game with file name "game0" and hit "start". The following is written to the file in logs/serverstart.log
18:24:52 11/09/2014 --serverName "DemoPlayers Turf Server" --saveGame "game0" --publicGame OFF --maxPlayers 100 --timeout 5000 --newGame OFF
The output is of the form [TIMESTAMP][TAB][Arguments].
You can run a server with the same settings by invoking:
vtserver --serverName "DemoPlayers Turf Server" --saveGame "game0" --publicGame OFF --maxPlayers 100 --timeout 5000 --newGame OFF
Common Game Settings
|Bases Allowed||Enable to allow land to be purchased and spawn flags placed|
|Block Place||Specifies where players are allowed to place and remove blocks:
|Start money||How much money new players start with when they join a server|
|Start credits||How many credits new players start with when they join a server|
|Free money per hour||How much money does each player receive every in-game hour|
|Free credits per hour||How many credits does each player get every in-game hour|
|Flag rate||Unused for now|
|Block placement allowed||Disables the purchase of block placing items if disabled|
|Weapon use allowed||Disables the purchase of weapons if disabled|
|Free Item||Specifies what items players get when they first join the server. Can be used to start players with infinite stacks|
Banlists and WhitelistsThe banlist is located at settings/blacklist.txt. Any servers running will appear invisible to any clients trying to connect to them. Place %WHITELIST in this file to turn it into a whitelist. This means that only players on the list will be able to join the server.
You cannot have both a banlist and a whitelist at the same time.
Refer to the console command guide as to how to use the /ban, /unban, /whitelist and /unwhitelist commands.
It is recommended that you ban DemoPlayer to prevent griefing.