mirror of
https://github.com/YuzuZensai/palworld-server-docker.git
synced 2026-01-31 14:57:59 +00:00
fix typo add docs
This commit is contained in:
Thijs van Loef
66
README.md
66
README.md
@@ -118,7 +118,7 @@ It is highly recommended you set the following environment values before startin
|
|||||||
* PGID
|
* PGID
|
||||||
|
|
||||||
| Variable | Info | Default Values | Allowed Values |
|
| Variable | Info | Default Values | Allowed Values |
|
||||||
|--------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------|------------------------------------------------------------------------------------------------------------|
|
|--------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------|------------------------------------------------------------------------------------------------------------|
|
||||||
| TZ | Timezone used for time stamping backup server | UTC | See [TZ Identifiers](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#Time_Zone_abbreviations) |
|
| TZ | Timezone used for time stamping backup server | UTC | See [TZ Identifiers](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#Time_Zone_abbreviations) |
|
||||||
| PLAYERS* | Max amount of players that are able to join the server | 16 | 1-32 |
|
| PLAYERS* | Max amount of players that are able to join the server | 16 | 1-32 |
|
||||||
| PORT* | UDP port that the server will expose | 8211 | 1024-65535 |
|
| PORT* | UDP port that the server will expose | 8211 | 1024-65535 |
|
||||||
@@ -198,6 +198,70 @@ The server will run a save before the backup if rcon is enabled.
|
|||||||
|
|
||||||
## Editing Server Settings
|
## Editing Server Settings
|
||||||
|
|
||||||
|
### With Environment Variables
|
||||||
|
|
||||||
|
> [!IMPORTANT]
|
||||||
|
>
|
||||||
|
> These Environment Variables/Settings are subject to change since the game is still in beta
|
||||||
|
|
||||||
|
| Variable | Description | Default Value | Allowed Value PLAYER_STOMACH_DECREASE_RATE |
|
||||||
|
|-------------------------------------------|------------------------------------------------------------------------|----------------------------------------------------------------------------------------------|--------------------------------------------------|
|
||||||
|
| NETSERVERMAXTICKRATE | Changes the TickRate of the server, be very careful with this setting! | 120 | 30-120 |
|
||||||
|
| DIFFICULTY | Game Difficulty: | None | `None`,`Normal`,`Difficult` |
|
||||||
|
| DAYTIME_SPEEDRATE | Day time speed - Smaller number means shorter days | 1.000000 | Float |
|
||||||
|
| NIGHTTIME_SPEEDRATE | Night time speed - Smaller number means shorter nights | 1.000000 | Float |
|
||||||
|
| EXP_RATE | EXP rate | 1.000000 | Float |
|
||||||
|
| PAL_CAPTURE_RATE | Pal capture rate | 1.000000 | Float |
|
||||||
|
| PAL_SPAWN_NUM_RATE | Pal appearance rate | 1.000000 | Float |
|
||||||
|
| PAL_DAMAGE_RATE_ATTACK | Damage from pals multipiler | 1.000000 | Float |
|
||||||
|
| PAL_DAMAGE_RATE_DEFENSE | Damage to pals multipiler | 1.000000 | Float |
|
||||||
|
| PLAYER_DAMAGE_RATE_ATTACK | Damage from player multipiler | 1.000000 | Float |
|
||||||
|
| PLAYER_DAMAGE_RATE_DEFENSE | Damage to player multipiler | 1.000000 | Float |
|
||||||
|
| PLAYER_STOMACH_DECREASE_RATE | Player hunger depletion rate | 1.000000 | Float |
|
||||||
|
| PLAYER_STAMINA_DECREASE_RATE | Player stamina reduction rate | 1.000000 | Float |
|
||||||
|
| PLAYER_AUTO_HP_REGEN_RATE | Player auto HP regeneration rate | 1.000000 | Float |
|
||||||
|
| PLAYER_AUTO_HP_REGEN_RATE_IN_SLEEP | Player sleep HP regeneration rate | 1.000000 | Float |
|
||||||
|
| PAL_STOMACH_DECREASE_RATE | Pal hunger depletion rate | 1.000000 | Float |
|
||||||
|
| PAL_STAMINA_DECREASE_RATE | Pal stamina reduction rate | 1.000000 | Float |
|
||||||
|
| PAL_AUTO_HP_REGEN_RATE | Pal auto HP regeneration rate | 1.000000 | Float |
|
||||||
|
| PAL_AUTO_HP_REGEN_RATE_IN_SLEEP | Pal sleep health regeneration rate (in Palbox) | 1.000000 | Float |
|
||||||
|
| BUILD_OBJECT_DAMAGE_RATE | Damage to structure multipiler | 1.000000 | Float |
|
||||||
|
| BUILD_OBJECT_DETERIORATION_DAMAGE_RATE | Structure determination rate | 1.000000 | Float |
|
||||||
|
| COLLECTION_DROP_RATE | Getherable items multipiler | 1.000000 | Float |
|
||||||
|
| COLLECTION_OBJECT_HP_RATE | Getherable objects HP multipiler | 1.000000 | Float |
|
||||||
|
| COLLECTION_OBJECT_RESPAWN_SPEED_RATE | Getherable objects respawn interval | 1.000000 | Float |
|
||||||
|
| ENEMY_DROP_ITEM_RATE | Dropped Items Multipiler | 1.000000 | Float |
|
||||||
|
| DEATH_PENALTY | What will drop when you die | All | `None`,`Item`,`ItemAndEquipment`,`All` |
|
||||||
|
| ENABLE_PLAYER_TO_PLAYER_DAMAGE | Allows players to cause damage to players | False | Boolean |
|
||||||
|
| ENABLE_FRIENDLY_FIRE | Allow friendly fire | False | Boolean |
|
||||||
|
| ENABLE_INVADER_ENEMY | Enable invaders | True | Boolean |
|
||||||
|
| ACTIVE_UNKO | Enable UNKO | False | Boolean |
|
||||||
|
| ENABLE_AIM_ASSIST_PAD | Enable controller aim assist | True | Boolean |
|
||||||
|
| ENABLE_AIM_ASSIST_KEYBOARD | Enable Keyboard aim assist | False | Boolean |
|
||||||
|
| DROP_ITEM_MAX_NUM | Maximum number of drops in the world | 3000 | Integer |
|
||||||
|
| DROP_ITEM_MAX_NUM_UNKO | Maximum number of UNKO drops in the world | 100 | Integer |
|
||||||
|
| BASE_CAMP_MAX_NUM | Maximum number of base camps | 128 | Integer |
|
||||||
|
| BASE_CAMP_WORKER_MAXNUM | Maximum number of workers | 15 | Integer |
|
||||||
|
| DROP_ITEM_ALIVE_MAX_HOURS | Time it takes for items to despawn in hours | 1.000000 | Float |
|
||||||
|
| AUTO_RESET_GUILD_NO_ONLINE_PLAYERS | Automatically reset guild when no players are online | False | Bool |
|
||||||
|
| AUTO_RESET_GUILD_TIME_NO_ONLINE_PLAYERS | Time to automatically reset guild when no players are online | 72.000000 | Float |
|
||||||
|
| GUILD_PLAYER_MAX_NUM | Max player of Guild | 20 | Integer |
|
||||||
|
| PAL_EGG_DEFAULT_HATCHING_TIME | Time(h) to incubate massive egg | 72.000000 | Float |
|
||||||
|
| WORK_SPEED_RATE | Work speed muliplier | 1.000000 | Float |
|
||||||
|
| IS_MULTIPLAY | Enable multiplayer | False | Boolean |
|
||||||
|
| IS_PVP | Enable PVP | False | Boolean |
|
||||||
|
| CAN_PICKUP_OTHER_GUILD_DEATH_PENALTY_DROP | Allow players from other guilds to pick up death penalty items | False | Boolean |
|
||||||
|
| ENABLE_NON_LOGIN_PENALTY | Enable non-login penalty | True | Boolean |
|
||||||
|
| ENABLE_FAST_TRAVEL | Enable fast travel | True | Boolean |
|
||||||
|
| IS_START_LOCATION_SELECT_BY_MAP | Enable selecting of start location | True | Boolean |
|
||||||
|
| EXIST_PLAYER_AFTER_LOGOUT | Toggle for deleting players when they log off | False | Boolean |
|
||||||
|
| ENABLE_DEFENSE_OTHER_GUILD_PLAYER | Allows defense against other guild players | False | Boolean |
|
||||||
|
| COOP_PLAYER_MAX_NUM | Maximum number of players in a guild | 4 | Integer |
|
||||||
|
| REGION | Area | | String |
|
||||||
|
| USEAUTH | Use authentication | True | Boolean |
|
||||||
|
| BAN_LIST_URL | Which ban list to use | [https://api.palworldgame.com/api/banlist.txt](https://api.palworldgame.com/api/banlist.txt) | string |
|
||||||
|
|
||||||
|
### Manually
|
||||||
When the server starts, a `PalWorldSettings.ini` file will be created in the following location: `<mount_folder>/Pal/Saved/Config/LinuxServer/PalWorldSettings.ini`
|
When the server starts, a `PalWorldSettings.ini` file will be created in the following location: `<mount_folder>/Pal/Saved/Config/LinuxServer/PalWorldSettings.ini`
|
||||||
|
|
||||||
Any changes made while the server is live will be overridden.
|
Any changes made while the server is live will be overridden.
|
||||||
|
|||||||
@@ -127,13 +127,13 @@ if [ -n "${PAL_STAMINA_DECREASE_RATE}" ]; then
|
|||||||
echo "PAL_STAMINA_DECREASE_RATE=$PAL_STAMINA_DECREASE_RATE"
|
echo "PAL_STAMINA_DECREASE_RATE=$PAL_STAMINA_DECREASE_RATE"
|
||||||
sed -E -i "s/PalStaminaDecreaceRate=[+-]?([0-9]*[.])?[0-9]+/PalStaminaDecreaceRate=$PAL_STAMINA_DECREASE_RATE/" /palworld/Pal/Saved/Config/LinuxServer/PalWorldSettings.ini
|
sed -E -i "s/PalStaminaDecreaceRate=[+-]?([0-9]*[.])?[0-9]+/PalStaminaDecreaceRate=$PAL_STAMINA_DECREASE_RATE/" /palworld/Pal/Saved/Config/LinuxServer/PalWorldSettings.ini
|
||||||
fi
|
fi
|
||||||
if [ -n "${PAL_AUTO_HP_REGENE_RATE}" ]; then
|
if [ -n "${PAL_AUTO_HP_REGEN_RATE}" ]; then
|
||||||
echo "PAL_AUTO_HP_REGENE_RATE=$PAL_AUTO_HP_REGENE_RATE"
|
echo "PAL_AUTO_HP_REGEN_RATE=$PAL_AUTO_HP_REGEN_RATE"
|
||||||
sed -E -i "s/PalAutoHPRegeneRate=[+-]?([0-9]*[.])?[0-9]+/PalAutoHPRegeneRate=$PAL_AUTO_HP_REGENE_RATE/" /palworld/Pal/Saved/Config/LinuxServer/PalWorldSettings.ini
|
sed -E -i "s/PalAutoHPRegeneRate=[+-]?([0-9]*[.])?[0-9]+/PalAutoHPRegeneRate=$PAL_AUTO_HP_REGEN_RATE/" /palworld/Pal/Saved/Config/LinuxServer/PalWorldSettings.ini
|
||||||
fi
|
fi
|
||||||
if [ -n "${PAL_AUTO_HP_REGENE_RATE_IN_SLEEP}" ]; then
|
if [ -n "${PAL_AUTO_HP_REGEN_RATE_IN_SLEEP}" ]; then
|
||||||
echo "PAL_AUTO_HP_REGENE_RATE_IN_SLEEP=$PAL_AUTO_HP_REGENE_RATE_IN_SLEEP"
|
echo "PAL_AUTO_HP_REGEN_RATE_IN_SLEEP=$PAL_AUTO_HP_REGEN_RATE_IN_SLEEP"
|
||||||
sed -E -i "s/PalAutoHpRegeneRateInSleep=[+-]?([0-9]*[.])?[0-9]+/PalAutoHpRegeneRateInSleep=$PAL_AUTO_HP_REGENE_RATE_IN_SLEEP/" /palworld/Pal/Saved/Config/LinuxServer/PalWorldSettings.ini
|
sed -E -i "s/PalAutoHpRegeneRateInSleep=[+-]?([0-9]*[.])?[0-9]+/PalAutoHpRegeneRateInSleep=$PAL_AUTO_HP_REGEN_RATE_IN_SLEEP/" /palworld/Pal/Saved/Config/LinuxServer/PalWorldSettings.ini
|
||||||
fi
|
fi
|
||||||
if [ -n "${BUILD_OBJECT_DAMAGE_RATE}" ]; then
|
if [ -n "${BUILD_OBJECT_DAMAGE_RATE}" ]; then
|
||||||
echo "BUILD_OBJECT_DAMAGE_RATE=$BUILD_OBJECT_DAMAGE_RATE"
|
echo "BUILD_OBJECT_DAMAGE_RATE=$BUILD_OBJECT_DAMAGE_RATE"
|
||||||
|
|||||||
Reference in New Issue
Block a user