User Tools

Site Tools


starting_a_server

Starting a multiplayer server

This page will cover how to start and run a multiplayer server on *nix, Windows, and Android operating systems. First download or compile Voxelands. (If you downloaded the static binary, extract it to a location.)

Before starting your server it is suggested that you edit the config file “voxelands.conf” and set the following options:

server_name = my server
server_address = my.server.com

This will set the name and domain name of your server in the server list.

You may also set api_announce = false if you do not want your server showing in the public list.

*NIX based systems : After compiled, change directory to the “bin” directory and start the server:

$ cd bin
$ ./voxelands-server --port 30000

Optionally, you can add

... --config ../voxelands.conf.example

to the end of the line above and uncomment out the options you wish to use within voxelands.conf.example.

Systemd.service This systemd service redirects the stdout to the journal service and restarts on various segfaults.

[Unit]
Description=Voxelands

[Service]
User=voxelands
ExecStart=/home/voxelands/voxelands/bin/voxelands-server --config /home/voxelands/voxelands/config.conf
StandardOutput=journal
WorkingDirectory=/home/voxelands/
Restart=on-abort

[Install]
WantedBy=multi-user.target

Windows : Navigate to the extracted directory and enter the “bin” directory. Create a batch file with the name start.bat or start.cmd if in windows 7 or newer. Right click the new script and click edit. After your default editor is displayed add this command to the fresh script.

voxelands-server.exe --port 30000

You can optionally add:

... --config ../voxelands.conf.example 

to the end of the line above and uncomment out the options you wish to use within voxelands.conf.example. Now execute the script and a command prompt will appear with some information regarding the server. Your server will now be running on the specified port in the command used inside the script.

Android : A detailed walk through has been created to lead one to running a Voxelands server on an Android device: Compiling Voxelands on Android

Notes : Note that port forwarding is required if you want people from outside your LAN to connect to the server.

starting_a_server.txt · Last modified: 2016/03/19 20:47 by darkrose