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
----------------------------------

The ``zoid.conf`` file is a good way to find out wich settings you can change and how these are called.

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 0.0.0.0;
       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 global chat press "y" or add "/all" before chatting <LINE> Press /help to have a list of server commands <LINE> <RGB:1,1,1> ';

       //-- 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;
       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;

           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 aus shown in the ``zoid.conf``

You now can override a value by adding it to your config, for example to change the adminpassword:

::

   my_server : server {
      adminpassword foobar;
   }