What do the options in my Project Zomboid config mean?
On AleForge the default name for your save file and configs is dedicated . Your config file will be named to what you set your Server Name to in our Configuration Guide. Below is the default path and file name for the main configuration file:
/home/container/.cache/Server/dedicated.ini
| Key | Description |
|---|---|
| PVP | Players can hurt and kill other players |
| PauseEmpty | Game time stops when there are no players online |
| GlobalChat | Toggles global chat on or off |
| Open | Clients may join without already having an account in the whitelist. If set to false, administrators must manually create username/password combos |
| ServerWelcomeMessage | The first welcome message visible in the chat panel. This will be displayed immediately after player login. you can use RGB colours to chance the colour of the welcome message. You can also use <LINE> to create a separate lines within your text. Use: <RGB:1,0,0> This message will show up red! |
| AutoCreateUserInWhiteList | Add unknown usernames to the whitelist when players join. Clients will supply their own username/password on joining. (This is for Open=true servers) |
| DisplayUserName | Display usernames above player’s heads in-game |
| ShowFirstAndLastName | Display first & last name above player’s heads |
| SpawnPoint | Force every new player to spawn at these set x,y,z world coordinates. Find desired coordinates at map.projectzomboid.com. (Ignored when 0,0,0) |
| SafetySystem | Players can enter and leave PVP on an individual basis. A player can only hurt another player when at least one of them is in PVP mode - as shown by the unobscured skull and crossbones on the left of the screen. When SafetySystem=false, players are free to hurt each other at any time if PVP is enabled. |
| ShowSafety | Display a skull icon over the head of players who have entered PVP mode |
| SafetyToggleTimer | The time it takes for a player to enter and leave PVP mode\nMinimum=0 Maximum=1000 Default=2 |
| SafetyCooldownTimer | The delay before a player can enter or leave PVP mode again, having recently done so\nMinimum=0 Maximum=1000 Default=3 |
| SpawnItems | Item types new players spawn with.\nSeparate multiple item types with commas.\nExample: Base.Axe,Base.Bag_BigHikingBag |
| DefaultPort | Do Not Touch |
| UDPPort | Do Not Touch |
| Mods | Enter the mod loading ID here. It can be found in \Steam\steamapps\workshop\modID\mods\modName\info.txt |
| Map | Enter the foldername of the mod found in \Steam\steamapps\workshop\modID\mods\modName\media\maps\ |
| DoLuaChecksum | Kick clients whose game files don’t match the server’s |
| DenyLoginOnOverloadedServer | Prevent new connections if the server is overloaded |
| Public | Shows the server on the in-game browser. (Note: Steam-enabled servers are always visible in the Steam server browser) |
| PublicName | Name of the server displayed in the in-game browser and, if applicable, the Steam browser |
| PublicDescription | Description displayed in the in-game public server browser. Typing \n will create a new line in your description |
| MaxPlayers | A maximum number of players that can be on the server at one time. This excludes admins. WARNING: Server player counts above 32 will potentially result in poor map streaming and desync. Please advance with caution.\nMinimum=1 Maximum=100 Default=32 |
| PingLimit | Ping limit, in milliseconds, before a player is kicked from the server. (Set to 100 to disable)\nMinimum=100 Maximum=2147483647 Default=400 |
| HoursForLootRespawn | After X hours, all containers in the world will respawn loot. To spawn loot a container must have been looted at least once. Loot respawn is not impacted by visibility or subsequent looting.\nMinimum=0 Maximum=2147483647 Default=0 |
| MaxItemsForLootRespawn | Containers with a number of items greater, or equal to, this setting will not respawn\nMinimum=1 Maximum=2147483647 Default=4 |
| ConstructionPreventsLootRespawn | Items will not respawn in buildings that players have barricaded or built in |
| DropOffWhiteListAfterDeath | Remove player accounts from the whitelist after death. This prevents players creating a new character after death on Open=false servers |
| NoFire | All forms of fire are disabled - except for campfires |
| AnnounceDeath | If checked, every time a player dies a global message will be displayed in the chat |
| MinutesPerPage | The number of in-game minutes it takes to read one page of a book\nMinimum=0.00 Maximum=60.00 Default=1.00 |
| SaveWorldEveryMinutes | Loaded parts of the map are saved after this set number of real-world minutes have passed. (The map is usually saved only after clients leave a loaded area)\nMinimum=0 Maximum=2147483647 Default=0 |
| PlayerSafehouse | Both admins and players can claim safehouses |
| AdminSafehouse | Only admins can claim safehouses |
| SafehouseAllowTrepass | Allow non-members to enter a safehouse without being invited |
| SafehouseAllowFire | Allow fire to damage safehouses |
| SafehouseAllowLoot | Allow non-members to take items from safehouses |
| SafehouseAllowRespawn | Players will respawn in a safehouse that they were a member of before they died |
| SafehouseDaySurvivedToClaim | Players must have survived this number of in-game days before they are allowed to claim a safehouse\nMinimum=0 Maximum=2147483647 Default=0 |
| SafeHouseRemovalTime | Players are automatically removed from a safehouse they have not visited for this many real-world hours\nMinimum=0 Maximum=2147483647 Default=144 |
| SafehouseAllowNonResidential | Governs whether players can claim non-residential buildings |
| SledgehammerOnlyInSafehouse | Allow players to destroy world objects with sledgehammers |
| KickFastPlayers | Kick players that appear to be moving faster than is possible. May be buggy – use with caution. |
| ServerPlayerID | ServerPlayerID determines if a character is from another server, or single player. This value may be changed by soft resets. If this number does match the client, the client must create a new character. This is used in conjunction with ResetID. It is strongly advised that you backup these ID somewhere |
| RCONPort | Contact Support to have RCON setup |
| RCONPassword | RCON password (Pick a strong password) |
| DiscordEnable | Enables global text chat integration with a Discord channel |
| DiscordToken | Discord bot access token |
| DiscordChannel | The Discord channel name. (Try the separate channel ID option if having difficulties) |
| DiscordChannelID | The Discord channel ID. (Use if having difficulties with Discord channel name option) |
| Password | Clients must know this password to join the server. (Ignored when hosting a server via the Host button) |
| MaxAccountsPerUser | Limits the number of different accounts a single Steam user may create on this server. Ignored when using the Hosts button.\nMinimum=0 Maximum=2147483647 Default=0 |
| AllowCoop | Allow co-op/splitscreen players |
| SleepAllowed | Players are allowed to sleep when their survivor becomes tired, but they do not NEED to sleep |
| SleepNeeded | Players get tired and need to sleep. (Ignored if SleepAllowed=false) |
| KnockedDownAllowed | Players can be knocked down |
| SneakModeHideFromOtherPlayers | Players can hide from each other |
| WorkshopItems | List Workshop Mod IDs for the server to download. Each must be separated by a semicolon. Example: WorkshopItems=514427485;513111049 |
| SteamScoreboard | Show Steam usernames and avatars in the Players list. Can be true (visible to everyone), false (visible to no one), or admin (visible to only admins) |
| SteamVAC | Enable the Steam VAC system |
| UPnP | Attempt to configure a UPnP-enabled internet gateway to automatically setup port forwarding rules. The server will fall back to default ports if this fails. This shouldn’t need to be adjusted on AleForge hosting |
| VoiceEnable | VOIP is enabled when checked |
| VoiceMinDistance | The minimum tile distance over which VOIP sounds can be heard.\nMinimum=0.00 Maximum=100000.00 Default=10.00 |
| VoiceMaxDistance | The maximum tile distance over which VOIP sounds can beheard.\nMinimum=0.00 Maximum=100000.00 Default=100.00 |
| Voice3D | Toggle directional audio for VOIP |
| SpeedLimit | Minimum=10.00 Maximum=150.00 Default=70.00 |
| LoginQueueEnabled | When the server is full enable a queue for connecting players |
| LoginQueueConnectTimeout | Minimum=20 Maximum=1200 Default=60 |
| server_browser_announced_ip | Set the IP from which the server is broadcast. This is for network configurations with multiple IP addresses, such as server farms. Does not need adjusted on AleForge hosting |
| PlayerRespawnWithSelf | Players can respawn in-game at the coordinates where they died |
| PlayerRespawnWithOther | Players can respawn in-game at a split screen / Remote Play player’s location |
| FastForwardMultiplier | Governs how fast time passes while players sleep. Value multiplies the speed of the time that passes during sleeping.\nMinimum=1.00 Maximum=100.00 Default=40.00 |
| DisableSafehouseWhenPlayerConnected | Safehouse acts like a normal house if a member of the safehouse is connected (so secure when players are offline) |
| Faction | Players can create factions when true |
| FactionDaySurvivedToCreate | Players must survive this number of in-game days before being allowed to create a faction\nMinimum=0 Maximum=2147483647 Default=0 |
| FactionPlayersRequiredForTag | Number of players required as faction members before the faction owner can create a group tag\nMinimum=1 Maximum=2147483647 Default=1 |
| DisableRadioStaff | Disables radio transmissions from players with an access level |
| DisableRadioAdmin | Disables radio transmissions from players with ‘admin’ access level |
| DisableRadioGM | Disables radio transmissions from players with ‘gm’ access level |
| DisableRadioOverseer | Disables radio transmissions from players with ‘overseer’ access level |
| DisableRadioModerator | Disables radio transmissions from players with ‘moderator’ access level |
| DisableRadioInvisible | Disables radio transmissions from invisible players |
| ClientCommandFilter | Semicolon-separated list of commands that will not be written to the cmd.txt server log. For example: \n-vehicle. Inputting * means do NOT write any vehicle command. Inputting: \n+vehicle.installPart means DO write that command |
| ClientActionLogs | Semicolon-separated list of actions that will be written to the ClientActionLogs.txt server log |
| PerkLogs | Track changes in player perk levels in PerkLog.txt server log |
| ItemNumbersLimitPerContainer | Maximum number of items that can be placed in a container. Zero means there is no limit. (PLEASE NOTE: This includes individual small items such as nails. A limit of 50 will mean only 50 nails can be stored.)\nMinimum=0 Maximum=9000 Default=0 |
| BloodSplatLifespanDays | Number of days before old blood splats are removed. Removal happens when map chunks are loaded. Zero means they will never disappear\nMinimum=0 Maximum=365 Default=0 |
| AllowNonAsciiUsername | Allow use of non-ASCII (cyrillic etc) characters in usernames |
| RemovePlayerCorpsesOnCorpseRemoval | If enabled, when HoursForCorpseRemoval triggers, it will also remove player?s corpses from the ground. |
| TrashDeleteAll | If true, player can use the “delete all” button on bins |
| PVPMeleeWhileHitReaction | If true, player can hit again when struck by another player |
| MouseOverToSeeDisplayName | If true, players will have to mouse over someone to see their display name |
| HidePlayersBehindYou | If true, automatically hide the player you can’t see (like zombies) |
| PVPMeleeDamageModifier | Damage multiplier for PVP melee attacks.\nMinimum=0.00 Maximum=500.00 Default=30.00 |
| PVPFirearmDamageModifier | Damage multiplier for PVP ranged attacks.\nMinimum=0.00 Maximum=500.00 Default=50.00 |
| CarEngineAttractionModifier | Modify the range of zombie attraction to cars. (Lower values can help with lag.)\nMinimum=0.00 Maximum=10.00 Default=0.50 |
| PlayerBumpPlayer | Governs whether players bump (and knock over) other players when running through them |
| MapRemotePlayerVisibility | Controls display of remote players on the in-game map.\n1=Hidden 2=Friends 3=Everyone\nMinimum=1 Maximum=3 Default=1 |
| BackupsCount | Minimum=1 Maximum=300 Default=5 |
| BackupsOnStart | Create backup on server boot |
| BackupsOnVersionChange | Create a backup when the server is updated |
| BackupsPeriod | Minimum=0 Maximum=1500 Default=0 |