Command Line Tools

Initializing the environment

If you using Zoid for the first time you have to initialize its environment. Zoid then will create its home folder and downloading steamcmd

$ zoid-init --create-home

Creating a new server

To create a server you need to create a configuration file for it. You can do this manually or let Zoid create a barebone one for you.

For this open a command-prompt and type:

$ zoid-create testserver

This will create a fresh server configuration file with the name/ID testserver.

Starting the server

To start the server now type:

$ zoid-start testserver

If this is the first time you start a server Zoid will now first download the server files, this may take a while. After that the server will be started and Zoid prints something like that:

[INFO] Zoid by David "Uranoxyd" Ewelt. Version: 0.1.7
[INFO] starting server 'testserver'. depending on if you using steam workshop mods the start can take a while.
[INFO] server started successfully

Stopping the server

To stop the server type:

$ zoid-stop testserver

This will not shutdown the server if there are players connected, to force a shutdown in this case type

$ zoid-stop -f testserver

If you want to be shure the server gets terminated, even if a gracefull shutdown fails type:

$ zoid-stop -f --kill-on-fail testserver

This will kill the server process if a gracefull shutdown fails.

Killing the server

It could happen that you have a running server but zoid-stop can’t shut it down. You then have to kill the server process, for this type:

$ zoid-kill testserver

Listing servers

To print a list of your servers type:

$ zoid-ls

You will get a list like this:

---------------------------------------------------------
Name       | IP      | Port  | Branch | Running | Players
---------------------------------------------------------
testserver | 0.0.0.0 | 16261 | master |     Yes |       1
---------------------------------------------------------

Updating/Validating the server files

To update the server files to a new version type:

$ zoid-validate master

or for the IWBUMS branch

$ zoid-validate iwillbackupmysave -p iaccepttheconsequences

Creating a server backup

$ zoid-backup testserver

Zoid then will create a backup of the savegame files and write it under a file like .zoid/backups/testserver-YYYY-MM-DD-HH-MM-SS.zip