zoid Documentation Release David Ewelt

Transcription

1 zoid Documentation Release David Ewelt December 13, 2016

2

3 Contents 1 Features 3 2 Get started 5 3 Credits 13 i

4 ii

5 Zoid is a set of command line tools for easy hosting of one or more Project Zomboid servers. Contents 1

6 2 Contents

7 CHAPTER 1 Features Runs on Windows and Linux (tested) and possible Mac but not tested for now Makes it realy easy to get started a new server even for unexperienced users Multiple servers can be managed with one set of command line tools Inheritable configuration system makes it easy to host multiple servers with same config settings Written in pure Python so all features can be accessed thru a Python package [in dev.] API interface / Web-Panel 3

8 4 Chapter 1. Features

9 CHAPTER 2 Get started 2.1 Quickstart Linux Quickstart Installation On 64 bit systems you need the 32 bit GCC support library. This is needed for steamcmd to work. # apt-get install lib32gcc1 Installation via PIP The easiest and recommended way to install or upgrade Zoid is via PIP, if you dont have it you can install it via: # apt-get install python-pip Now type: # pip install zoid --no-use-wheel The --no-use-wheel switch is needed because there is a bug installing wheels in the newest PIP versions. To upgrade to a newer version you have to type # pip install --upgrade zoid --no-use-wheel Installation with virtualenv You also can use Zoid using virtualenv $ virtualenv venv $. venv/bin/activate $ pip install zoid --no-use-wheel Installation from sources You surely can install it from sources # wget # tar xfvz zoid tar.gz # cd zoid tar.gz # python setup.py install 5

10 Whats next? You can now continue reading: Using Zoid 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: [INFO] starting server 'testserver'. depending on if you using steam workshop mods the start can take [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 6 Chapter 2. Get started

11 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 master Yes 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 Configuring The main configuration file for Zoid is called zoid.conf and you can find it under its home folder, i.e..zoid/zoid.conf. Normally you dont want to change this file, instead you will create new configurations files wich Zoid then loads automatically. Creating a minmal server configuration To create a new barebone configuration for a new server you can use the zoid-create tool, but here i will explain you the manual way. Create a new file in the.zoid home folder and call it something like my_server.conf, now open it. In this file type: my_server : server { adminpassword foobar; rcon { password foobar; Replace foobar with your own passwords. The my_server in the first line will become the internal name or id of your server. You use this name in all tools to reference to this server, i.e zoid-start my_server to start the server. Use the zoid.conf as reference and how these are called. The zoid.conf file is a good way to find out wich settings you can change 2.1. Quickstart 7

12 Here is the complete server section from the zoid.conf, you will find all the settings from the main.ini file, and in the sandbox node all the settings from the SandboxVars.lua file. So it contains all settings you might want change. server { ip ; port 16261; password; adminpassword; beta; betapassword; ping_frequency 10; ping_limt 400; max_players 64; max_accounts 0; //-- online apperance public false; public_name My Zoid PZ Server; public_description; welcome_message ' <RGB:1,0,0> Welcome to Project Zomboid MP! to chat locally press "t", to globa //-- whitelist open true; auto_whitelist false; drop_whitelist false; //-- system pause_empty false; global_chat true; announce_death false; corpse_removal 0; nightlengthmodifier 1.0; save_world_every 0; minutes_per_page 1.0; //-- pvp / safety pvp true; safety_system true; show_safety true; safety_toggle_timer 100; safety_cooldown_timer 120; display_username true; allow_sledge true; //-- security kick_fast false; do_lua_checksum true; log_local_chat false; //-- spawn map Muldraugh, KY; spawn_regions; spawn_items; 8 Chapter 2. Get started

13 spawn_point 0,0,0; //-- mods mods; //-- loot respawn hours_for_lootrespawn 0; max_items_for_lootrespawn 4; construction_prevents_lootrespawn true; //-- safehouse safehouse { admin false; player false; trespass true; fire true; loot true; respawn false; claim 0; removal 144; //-- fire no_fire false; no_fire_spread false; //-- steam steam { enable false; port1 8766; port2 8767; vac true; scoreboard true; workshop_items; rcon { port 28015; password; sandbox { override_lua false; speed 3; zombies 3; distribution 1; survivors 1; day_length 2; start_year 1; start_month 7; start_day 9; start_time 2; water_shut_modifier 14; elec_shut_modifier 14; 2.1. Quickstart 9

14 food_loot 2; weapon_loot 2; other_loot 2; temperature 3; rain 3; erosion_speed 3; xp_multiplier 1.0; stats_decrease 3; nature_abundance 3; alarm 4; locked_houses 6; food_rot_speed 3; fridge_factor 3; farming 3; loot_respawn 1; starter_kit false; time_since_apo 1; plant_resilience 3; plant_abundance 3; end_regen 3; zombie_lore { speed 2; strength 2; toughness 2; transmission 1; mortality 5; reanimate 3; cognition 3; memory 2; decomp 1; sight 2; hearing 2; smell 2; thump_no_chasing 1; vm { xms 2048m; xmx 2048m; reset_id; server_player_id; Overriting/Changing settings The Zoid configuration files allows for inheritance of other configuration settings, this is was the : server { part in the example configuration does. If your configuration file looks like: my_server : server { Then the configuration Zoid reads, will be the exact same as shown in the zoid.conf 10 Chapter 2. Get started

15 You now can override a value by adding it to your config, for example to change the adminpassword: my_server : server { adminpassword foobar; Windows Quickstart Installation For Windows my suggestion is to use the standalone setup. You then dont have to install Python or other dependencies. It consists of ready-to-use executable files. You can download it here: Download the latest version file that ends with standalone-setup.exe and run it. After the setup is finished a black window will appear and Zoid will initialize its environment. This means in detail that it will create its home folder.zoid, download steamcmd and perform a short selftest. Using the command promt Zoid is a command-line tool, so you need to know how you open and use it. Press Windows Key + R and in this dialog type cmd. You now should see the command-prompt window: 2.1. Quickstart 11

16 Now to ensure Zoid is installed and working correctly type zoid-init -V. Zoid should now print its version number to you. Whats next? You can now continue reading: 12 Chapter 2. Get started

17 CHAPTER 3 Credits Andreas Klauer for his SourceRcon script Indie Stone for the great game 13