ENV_VARS.md

Environment Variables

Back to main

In this section you will find a lot of environment variables to control your container-behavior and gameserver-settings. Due to the extensive control options, the settings are split into two parts for documentation: Container-Settings and Gameserver-Settings.

Container-Settings

These settings control the behavior of the Docker container:

Important: If you want to change the server settings via environment variables use the default value (auto) for the environment variable SERVER_SETTINGS_MODE, otherwise change it to manual and edit the config file directly.

Variable	Description	Default value	Allowed values
PUID	PUID stands for Process User ID, also known as UID	1000	Integer
PGID	PGID stands for Process Group ID, also known as GID	1000	Integer
TZ	Timezone used for time stamping server backups	Europe/Berlin	See TZ identifiers
ALWAYS_UPDATE_ON_START	Updates the server on startup	true	Boolean
STEAMCMD_VALIDATE_FILES	Set to enabled SteamCMD will also validate the gameserver files, making sure nothing is corrupted and also overwrite any file changes of the source	true	Boolean
BACKUP_ENABLED	Backup function, creates backups in your game directory	true	Boolean
BACKUP_CRON_EXPRESSION	Needs a Cron-Expression - See Cron expression	0 * * * * (meaning every hour)	Cron-Expression
BACKUP_RETENTION_POLICY	Set to enabled, will cleanup old backups	true	Boolean
BACKUP_RETENTION_AMOUNT_TO_KEEP	Defines how many backups in numbers to keep	72	Integer
RESTART_ENABLED	Automatic restarts the server	false	Boolean
RESTART_DEBUG_OVERRIDE	Automatic restarts down to 15 seconds instead of 15 minutes	false	Boolean
RESTART_CRON_EXPRESSION	Needs a Cron-Expression - See Cron expression	0 3,15 * * *	Cron-Expression
RCON_PLAYER_DETECTION	Set to enabled will send player join and leaves to console, rcon and webhooks, NEEDS RCON_ENABLED	true	Boolean
RCON_PLAYER_DETECTION_STARTUP_DELAY	Initial delay for start checking for players, consider steam-updates and server start up in seconds	60	Integer
RCON_PLAYER_DETECTION_CHECK_INTERVAL	Interval in seconds to wait for next check in the infinite loop	15	Integer
WEBHOOK_ENABLED	Set to enabled will send webhook notifications, NEEDS WEBHOOK_URL	false	Boolean
WEBHOOK_DEBUG_ENABLED	Set to enabled will enable feedback of curl and not use --silent	false	Boolean
WEBHOOK_URL	Defines the url the webhook to send data to		Url
WEBHOOK_CONTENT_TITLE	If set to a value this will add the "content" segment for the webhook, set to empty removes it	Status update	String
WEBHOOK_*	See below the table "Webhook environment variables"		String
SERVER_SETTINGS_MODE	Determines whether settings can be modified via environment variables or via file, except COMMUNITY_SERVER and MULTITHREAD_ENABLED!	auto	Enum

SERVER_SETTINGS_MODE explained

SERVER_SETTINGS_MODE accepts 2 values:

• auto: Settings are modified only by environment variables, manual edits will be ignored
• rcononly: RCON-Settings are modified by environment variables (RCON_ENABLED, RCON_PORT, ADMIN_PASSWORD), everything else has to be done by editing the file directly, other environment variables are ignored
• manual: Settings are modified only by editing the file directly, environment variables are ignored

Webhook environment variables

Warning

IMPORTANT: Don't use Hex-Colors!

Go to the page, search for the Hex-Color, after that add the DECIMAL-Representation to the color field or it will break for Discord!

https://www.spycolor.com/

There are a lot of Variables to setup for messages and colors to send to the webhook url in the default.env

TZ identifiers

The TZ setting affects logging output and the backup function. TZ identifiers are a format for defining a timezone near you.

Cron expression

The BACKUP_CRON_EXPRESSION setting affects the backup function. In a Cron-Expression, you define an interval for when to run jobs. This image uses Supercronic for crons, see https://github.com/aptible/supercronic#crontab-format or https://crontab-generator.org

Gameserver-Settings

This section lists all the settings currently adjustable via Docker environment variables, based on the order and contents of the DefaultPalWorldSettings.ini.

Information sources and credits to the following websites:

• Palworld Tech Guide for the game server documentation
• PalworldSettingGenerator for variable descriptions

Important: Please note that all of this is subject to change. The game is still in early access.

To change a setting, you can set the environment variable to the value you want. If the environment variable is not set or is blank, the default value will be used.

Variable	Game setting	Description	Default value	Allowed value
MULTITHREAD_ENABLED	Sets options for "Improved multi-threaded CPU performance"	true	true	Boolean
COMMUNITY_SERVER	Set to enabled, the server will appear in the Community-Serverlist	true	true	Boolean
NETSERVERMAXTICKRATE	NetServerMaxTickRate	Changes the TickRate of the server, be very careful with this setting!	120	30-120
DIFFICULTY	Difficulty	Choose one of the following: None Normal Difficult	None	Enum
DAYTIME_SPEEDRATE	DayTimeSpeedRate	Day Time Speed: The lower this number is, the longer each day will last.	1.000000	Float
NIGHTTIME_SPEEDRATE	NightTimeSpeedRate	Night Time Speed: The lower this number is, the longer each night will last.	1.000000	Float
EXP_RATE	ExpRate	EXP Rate: The higher this number is, the more EXP you will gain.	1.000000	Float
PAL_CAPTURE_RATE	PalCaptureRate	Pal Capture Rate: The higher this number is, the greater your chance of capturing a Pal.	1.000000	Float
PAL_SPAWN_NUM_RATE	PalSpawnNumRate	Pal Appearance Rate: The higher this number is, the more Pals that will spawn.	1.000000	Float
PAL_DAMAGE_RATE_ATTACK	PalDamageRateAttack	Damage From Pals Multiplier: The lower this number is, the less damage you and your Pals will take from wild Pals during combat. Also decreases the damage output of your Pals.	1.000000	Float
PAL_DAMAGE_RATE_DEFENSE	PalDamageRateDefense	Damage To Pals Multiplier: The higher this number is, the more damage you and your Pals will do to wild Pals during combat. Also increases the damage your Pals receive.	1.000000	Float
PLAYER_DAMAGE_RATE_ATTACK	PlayerDamageRateAttack	Damage From Player Multiplier: The higher this number is, the greater the damage output of your character.	1.000000	Float
PLAYER_DAMAGE_RATE_DEFENSE	PlayerDamageRateDefense	Damage To Player Multiplier: The lower this number is, the less damage your character will take during combat.	1.000000	Float
PLAYER_STOMACH_DECREASE_RATE	PlayerStomachDecreaceRate	Player Hunger Depletion Rate: The lower this number is, the longer it will take for your character to get hungry.	1.000000	Float
PLAYER_STAMINA_DECREACE_RATE	PlayerStaminaDecreaceRate	Player Stamina Reduction Rate: The lower this number is, the longer it will take for your character to run out of stamina.	1.000000	Float
PLAYER_AUTO_HP_REGENE_RATE	PlayerAutoHPRegeneRate	Player Auto HP Regeneration Rate: The higher this number is, the faster your character will recover health.	1.000000	Float
PLAYER_AUTO_HP_REGENE_RATE_IN_SLEEP	PlayerAutoHpRegeneRateInSleep	Player Sleep HP Regeneration Rate: The higher this number is, the faster your character will recover health when sleeping.	1.000000	Float
PAL_STOMACH_DECREACE_RATE	PalStomachDecreaceRate	Pal Hunger Depletion Rate: The lower this number is, the longer it will take for your Pals to get hungry.	1.000000	Float
PAL_STAMINA_DECREACE_RATE	PalStaminaDecreaceRate	Pal Stamina Reduction Rate: The lower this number is, the longer it will take for your Pals stamina to run out.	1.000000	Float
PAL_AUTO_HP_REGENE_RATE	PalAutoHPRegeneRate	Pal Auto HP Regeneration Rate: The higher this number is, the faster your Pal will recover health.	1.000000	Float
PAL_AUTO_HP_REGENE_RATE_IN_SLEEP	PalAutoHpRegeneRateInSleep	Pal Sleep Health Regeneration Rate: The higher this number is, the faster your Pal will recover health when inside the Palbox.	1.000000	Float
BUILD_OBJECT_DAMAGE_RATE	BuildObjectDamageRate	Damage To Structure Multiplier: The lower this number is, the less damage your structures and builds will take.	1.000000	Float
BUILD_OBJECT_DETERIORATION_DAMAGE_RATE	BuildObjectDeteriorationDamageRate	Structure Deterioration Rate: The lower this number is, the slower the deterioration will be for structures and builds, with 0 meaning no deterioration.	1.000000	Float
COLLECTION_DROP_RATE	CollectionDropRate	Gatherable Items Multiplier: The higher this number is, the more resources you will receive from mining, lumbering etc.	1.000000	Float
COLLECTION_OBJECT_HP_RATE	CollectionObjectHpRate	Gatherable Objects HP Multiplier: The lower this number is, the faster objects/resources like rocks will disintegrate when mining. (Note: in my experience, this change only took effect to objects like rocks after it had been destroyed and respawned.) (Note: in my experience, there didn’t appear to be any change in how long it took for a tree to be completely chopped, taking 15 hits regardless of the multiplier.)	1.000000	Float
COLLECTION_OBJECT_RESPAWN_SPEED_RATE	CollectionObjectRespawnSpeedRate	Gatherable Objects Respawn Interval: The lower this number is, the faster resources will respawn. (Note: in my experience, there didn’t appear to be any change in how long it took for a tree to respawn once completely chopped, taking 30 minutes regardless of the multiplier.)	1.000000	Float
ENEMY_DROP_ITEM_RATE	EnemyDropItemRate	Dropped Items Multiplier: The higher this number is, the more items/materials you will receive when defeating a Pal.	1.000000	Float
DEATH_PENALTY	DeathPenalty	None : No lost Item : Lost item without equipment ItemAndEquipment : Lost item and equipment All: Lost All item, equipment, pal(in inventory)	All	Enum
ENABLE_PLAYER_TO_PLAYER_DAMAGE	bEnablePlayerToPlayerDamage	Allows players to cause damage to players	false	Boolean
ENABLE_FRIENDLY_FIRE	bEnableFriendlyFire	Allow friendly fire	false	Boolean
ENABLE_INVADER_ENEMY	bEnableInvaderEnemy	Enable Raid Events: This setting will determine whether your bases are raided by Pals, syndicate members etc.	true	Boolean
ACTIVE_UNKO	bActiveUNKO	Enable UNKO	false	Boolean
ENABLE_AIM_ASSIST_PAD	bEnableAimAssistPad	Enable controller aim assist	true	Boolean
ENABLE_AIM_ASSIST_KEYBOARD	bEnableAimAssistKeyboard	Enable Keyboard aim assist	false	Boolean
DROP_ITEM_MAX_NUM	DropItemMaxNum	Maximum Number of Dropped Items in A World: Self-explanatory. Note: increasing this number could potentially cause the game to slow down.	3000	Integer
DROP_ITEM_MAX_NUM_UNKO	DropItemMaxNum	Maximum number of UNKO drops in the world	100	Integer
BASE_CAMP_MAX_NUM	BaseCampMaxNum	Maximum number of base camps	128	Integer
BASE_CAMP_WORKER_MAXNUM	BaseCampWorkerMaxNum	Max Pals Working at Base: The higher this number is, the more Pals you can deploy to your base. You will still need to complete base missions to increase the capacity.	15	Integer
DROP_ITEM_ALIVE_MAX_HOURS	DropItemAliveMaxHours	Time it takes for items to despawn in hours	1.000000	Float
AUTO_RESET_GUILD_NO_ONLINE_PLAYERS	bAutoResetGuildNoOnlinePlayers	Automatically reset guild when no players are online	false	Bool
AUTO_RESET_GUILD_TIME_NO_ONLINE_PLAYERS	AutoResetGuildTimeNoOnlinePlayers	Time to automatically reset guild when no players are online	72.000000	Float
GUILD_PLAYER_MAX_NUM	GuildPlayerMaxNum	Max player of Guild	20	Integer
PAL_EGG_DEFAULT_HATCHING_TIME	PalEggDefaultHatchingTime	Incubate Egg Timer: The lower this number is, the faster eggs will hatch.	72.000000	Float
WORK_SPEED_RATE	WorkSpeedRate	Work speed multiplier	1.000000	Float
IS_MULTIPLAY	bIsMultiplay	Enable multiplayer	false	Boolean
IS_PVP	bIsPvP	Enable PVP	false	Boolean
CAN_PICKUP_OTHER_GUILD_DEATH_PENALTY_DROP	bCanPickupOtherGuildDeathPenaltyDrop	Allow players from other guilds to pick up death penalty items	false	Boolean
ENABLE_NON_LOGIN_PENALTY	bEnableNonLoginPenalty	Enable non-login penalty	true	Boolean
ENABLE_FAST_TRAVEL	bEnableFastTravel	Enable fast travel	true	Boolean
IS_START_LOCATION_SELECT_BY_MAP	bIsStartLocationSelectByMap	Enable selecting of start location	true	Boolean
EXIST_PLAYER_AFTER_LOGOUT	bExistPlayerAfterLogout	Toggle for deleting players when they log off	false	Boolean
ENABLE_DEFENSE_OTHER_GUILD_PLAYER	bEnableDefenseOtherGuildPlayer	Allows defense against other guild players	false	Boolean
COOP_PLAYER_MAX_NUM	CoopPlayerMaxNum	Maximum number of players in a guild	4	Integer
MAX_PLAYERS	ServerPlayerMaxNum	Maximum number of people who can join the server	32	Integer
SERVER_NAME	ServerName	Server name	jammsen-docker-generated-###RANDOM###	Integer
SERVER_DESCRIPTION	ServerDescription	Server description	Palworld-Dedicated-Server running in Docker by jammsen	String
ADMIN_PASSWORD	server admin password	AdminPassword	adminPasswordHere	String
SERVER_PASSWORD	AdminPassword	Set the server password.	serverPasswordHere	String
PUBLIC_PORT	public port	Public port number	8211	UInt16
PUBLIC_IP	public ip or FQDN	Public IP or FQDN		String
RCON_ENABLED	RCONEnabled	Enable RCON - Use ADMIN_PASSWORD to login	true	Boolean
RCON_PORT	RCONPort	Port number for RCON	25575	UInt16
REGION	Region	Area		String
USEAUTH	bUseAuth	Use authentication	true	Boolean
BAN_LIST_URL	BanListURL	Which ban list to use	https://api.palworldgame.com/api/banlist.txt	String
RESTAPI_ENABLED	RESTAPIEnabled	Enables the RESTAPI	true	Boolean
RESTAPI_PORT	RESTAPIPort	Defines the port inside the container where the API should be hosted - RESTAPI: Needs Basic Auth; admin:ADMIN_PASSWORD	8212	UInt16
SHOW_PLAYER_LIST	bShowPlayerList	Enables to view player-list ingame via the escape key	false	Boolean
ALLOW_CONNECT_PLATFORM	AllowConnectPlatform	Looks like Cross-Play, but according to official documentation, isnt working yet and no more infos given on this; See: https://tech.palworldgame.com/settings-and-operation/configuration	Steam	String
ENABLE_WORLD_BACKUP	bIsUseBackupSaveData	Enables internal world backup inside the game-server; off by default, because we have our own backup solution	false	Boolean

** Updates to descriptions taken from this reddit post **

Webhook-Settings

This section lists all the settings for the webhooks.

Warning

Please note that Hex-Colors (Example #eeeeee) are not supported. Instead, use the Decimal representation of the color. To convert a Hex-Color to its Decimal representation, you can use online tools such as SpyColor. Search for the Hex-Color and use the Decimal representation of that color. Using Hex-Colors will cause errors!

Variable	Description	Default Value	Allowed Values
WEBHOOK_ENABLED	Determines if the webhook is enabled	false	false/true
WEBHOOK_URL	The URL for the webhook	YOUR-URL-IN-HERE	Valid webhook URL
WEBHOOK_START_TITLE	The title for the start webhook	Server is starting	Message
WEBHOOK_START_DESCRIPTION	The description for the start webhook	The gameserver is starting	Message
WEBHOOK_START_COLOR	The color for the start webhook	2328576	Color (see below)
WEBHOOK_STOP_TITLE	The title for the stop webhook	Server has been stopped	Message
WEBHOOK_STOP_DESCRIPTION	The description for the stop webhook	The gameserver has been stopped	Message
WEBHOOK_STOP_COLOR	The color for the stop webhook	7413016"	Color (see below)
WEBHOOK_INFO_TITLE	The title for the info webhook	Info"	Message
WEBHOOK_INFO_DESCRIPTION	The description for the info webhook	This is an info from the server	Message
WEBHOOK_INFO_COLOR	The color for the info webhook	2849520	Color (see below)
WEBHOOK_UPDATE_TITLE	The title for the update webhook	Updating server	Message
WEBHOOK_UPDATE_DESCRIPTION	The description for the update webhook	Server is being updated	Message
WEBHOOK_UPDATE_COLOR	The color for the update webhook	2849520	Color (see below)
WEBHOOK_UPDATE_VALIDATION_TITLE	The title for the update and validation webhook	Updating and validating server	Message
WEBHOOK_UPDATE_VALIDATION_DESCRIPTION	The description for the update and validation webhook	Server is being updated and validated	Message
WEBHOOK_UPDATE_VALIDATION_COLOR	The color for the update and validation webhook	2849520	Color (see below)

Back to main