Palworld

https://docs.palworldgame.com/
Admin
This document provides instructions on how to build and operate a Palworld server, enabling players...
Tokens:10,092
Snippets:134
Trust Score:7.2
Update:3 months ago
Show doc for...
Tokens:
Raw
### Navigate to Server Directory on Linux

Source: https://docs.palworldgame.com/getting-started/deploy-dedicated-server

Change the current directory to the PalServer installation path on Linux.

```bash
cd ~/Steam/steamapps/common/PalServer  
```

--------------------------------

### Starting Location Selection

Source: https://docs.palworldgame.com/settings-and-operation/pvp

Enables or disables the ability for players to choose their starting location.

```ini
bIsStartLocationSelectByMap=True  
```

--------------------------------

### GET /v1/api/info

Source: https://docs.palworldgame.com/api/rest-api/info

Retrieves the current server information including version, name, description, and world GUID.

```APIDOC
## GET /v1/api/info

### Description
Retrieves the server information.

### Method
GET

### Endpoint
http://localhost:8212/v1/api/info

### Response
#### Success Response (200)
- **version** (string) - The server version.
- **servername** (string) - The server name.
- **description** (string) - The server description.
- **worldguid** (string) - The world GUID.

#### Response Example
{
  "version": "v0.1.5.0",
  "servername": "Palworld example Server",
  "description": "This is a Palworld server.",
  "worldguid": "A7E97BAA767DB9029EF013BB71E993A0"
}
```

--------------------------------

### Navigate to Server Directory on Windows

Source: https://docs.palworldgame.com/getting-started/deploy-dedicated-server

Change the current directory to the PalServer installation path on Windows.

```powershell
cd .\steamapps\common\PalServer  
```

--------------------------------

### GET http://localhost:8212/v1/api/settings

Source: https://docs.palworldgame.com/api/rest-api/settings

Retrieves the current server settings configuration.

```APIDOC
## GET http://localhost:8212/v1/api/settings

### Description
Retrieves the current server settings configuration for the Palworld server.

### Method
GET

### Endpoint
http://localhost:8212/v1/api/settings

### Response
#### Success Response (200)
- **Difficulty** (string) - Server difficulty setting
- **DayTimeSpeedRate** (number) - Speed rate for daytime
- **NightTimeSpeedRate** (number) - Speed rate for nighttime
- **ExpRate** (number) - Experience gain rate
- **PalCaptureRate** (number) - Pal capture success rate
- **PalSpawnNumRate** (number) - Pal spawn density rate
- **PalDamageRateAttack** (number) - Pal attack damage multiplier
- **PalDamageRateDefense** (number) - Pal defense damage multiplier
- **PlayerDamageRateAttack** (number) - Player attack damage multiplier
- **PlayerDamageRateDefense** (number) - Player defense damage multiplier
- **PlayerStomachDecreaceRate** (number) - Player hunger decrease rate
- **PlayerStaminaDecreaceRate** (number) - Player stamina decrease rate
- **PlayerAutoHPRegeneRate** (number) - Player HP regeneration rate
- **PlayerAutoHpRegeneRateInSleep** (number) - Player HP regeneration rate while sleeping
- **PalStomachDecreaceRate** (number) - Pal hunger decrease rate
- **PalStaminaDecreaceRate** (number) - Pal stamina decrease rate
- **PalAutoHPRegeneRate** (number) - Pal HP regeneration rate
- **PalAutoHpRegeneRateInSleep** (number) - Pal HP regeneration rate while sleeping
- **BuildObjectDamageRate** (number) - Damage rate to build objects
- **BuildObjectDeteriorationDamageRate** (number) - Deterioration rate of build objects
- **CollectionDropRate** (number) - Collection drop rate
- **CollectionObjectHpRate** (number) - Collection object HP rate
- **CollectionObjectRespawnSpeedRate** (number) - Collection object respawn speed
- **EnemyDropItemRate** (number) - Enemy item drop rate
- **DeathPenalty** (string) - Penalty applied upon death
- **bEnablePlayerToPlayerDamage** (boolean) - Whether PvP damage is enabled
- **bEnableFriendlyFire** (boolean) - Whether friendly fire is enabled
- **bEnableInvaderEnemy** (boolean) - Whether invader enemies are enabled
- **bActiveUNKO** (boolean) - Active UNKO status
- **bEnableAimAssistPad** (boolean) - Whether aim assist is enabled for gamepads
- **bEnableAimAssistKeyboard** (boolean) - Whether aim assist is enabled for keyboards
- **DropItemMaxNum** (number) - Maximum number of dropped items
- **DropItemMaxNum_UNKO** (number) - Maximum number of UNKO dropped items
- **BaseCampMaxNum** (number) - Maximum number of base camps
- **BaseCampWorkerMaxNum** (number) - Maximum number of workers per base camp
- **DropItemAliveMaxHours** (number) - Maximum hours dropped items persist
- **bAutoResetGuildNoOnlinePlayers** (boolean) - Whether to auto-reset guilds with no online players
- **AutoResetGuildTimeNoOnlinePlayers** (number) - Time threshold for guild auto-reset
- **GuildPlayerMaxNum** (number) - Maximum players per guild
- **PalEggDefaultHatchingTime** (number) - Default hatching time for Pal eggs
- **WorkSpeedRate** (number) - Work speed multiplier
- **bIsMultiplay** (boolean) - Whether multiplayer is enabled
- **bIsPvP** (boolean) - Whether PvP is enabled
- **bCanPickupOtherGuildDeathPenaltyDrop** (boolean) - Whether players can pick up items from other guilds' death penalties
- **bEnableNonLoginPenalty** (boolean) - Whether non-login penalty is enabled
- **bEnableFastTravel** (boolean) - Whether fast travel is enabled
- **bIsStartLocationSelectByMap** (boolean) - Whether start location is selected by map
- **bExistPlayerAfterLogout** (boolean) - Whether player character remains after logout
- **bEnableDefenseOtherGuildPlayer** (boolean) - Whether defense against other guild players is enabled
- **CoopPlayerMaxNum** (number) - Maximum co-op players
- **ServerPlayerMaxNum** (number) - Maximum server players
- **ServerName** (string) - Name of the server
- **ServerDescription** (string) - Description of the server
- **PublicPort** (number) - Public port number
- **PublicIP** (string) - Public IP address
- **RCONEnabled** (boolean) - Whether RCON is enabled
- **RCONPort** (number) - RCON port number
- **Region** (string) - Server region
- **bUseAuth** (boolean) - Whether authentication is required
- **BanListURL** (string) - URL for the ban list
- **RESTAPIEnabled** (boolean) - Whether REST API is enabled
- **RESTAPIPort** (number) - REST API port number
- **bShowPlayerList** (boolean) - Whether to show the player list
- **AllowConnectPlatform** (string) - Allowed connection platforms
- **bIsUseBackupSaveData** (boolean) - Whether backup save data is used
- **LogFormatType** (string) - Format type for logs
```

--------------------------------

### Start Dedicated Server on Windows

Source: https://docs.palworldgame.com/getting-started/deploy-dedicated-server

Execute the server binary to launch the Palworld dedicated server on Windows.

```powershell
PalServer.exe  
```

--------------------------------

### Configure Palworld Server Startup Arguments

Source: https://docs.palworldgame.com/settings-and-operation/arguments

Examples for setting the listen port and enabling multi-threaded performance optimizations on different operating systems.

```bash
PalServer.exe -port=8000 -useperfthreads -NoAsyncLoadingThread -UseMultithreadForDS  
```

```bash
./PalServer.sh -port=8000 -useperfthreads -NoAsyncLoadingThread -UseMultithreadForDS  
```

--------------------------------

### Start Dedicated Server on Linux

Source: https://docs.palworldgame.com/getting-started/deploy-dedicated-server

Execute the shell script to launch the Palworld dedicated server on Linux.

```bash
./PalServer.sh  
```

--------------------------------

### Retrieve Server Information via cURL

Source: https://docs.palworldgame.com/api/rest-api/info

Command-line example to fetch server information using cURL.

```bash
curl -L -X GET 'http://localhost:8212/v1/api/info' \
-H 'Accept: application/json'
```

--------------------------------

### Retrieve Server Settings via cURL

Source: https://docs.palworldgame.com/api/rest-api/settings

Example command to fetch server settings using the cURL utility.

```bash
curl -L -X GET 'http://localhost:8212/v1/api/settings' \
-H 'Accept: application/json'
```

--------------------------------

### Get Player List Endpoint

Source: https://docs.palworldgame.com/api/rest-api/players

The base endpoint for retrieving the player list via a GET request.

```http
GET 
http://localhost:8212/v1/api/players
```

--------------------------------

### Retrieve Player List via cURL

Source: https://docs.palworldgame.com/api/rest-api/players

Example command to fetch the player list using cURL.

```bash
curl -L -X GET 'http://localhost:8212/v1/api/players' \
-H 'Accept: application/json'
```

--------------------------------

### Save World via cURL

Source: https://docs.palworldgame.com/api/rest-api/save

Command line example to perform a POST request to the save endpoint.

```bash
curl -L -X POST 'http://localhost:8212/v1/api/save'
```

--------------------------------

### Retrieve Game Data via cURL

Source: https://docs.palworldgame.com/api/rest-api/game-data

Example command to fetch the world snapshot using cURL.

```bash
curl -L -X GET 'http://localhost:8212/v1/api/game-data' \
-H 'Accept: application/json'
```

--------------------------------

### Unban Player via cURL

Source: https://docs.palworldgame.com/api/rest-api/unban

Example command to unban a player using the cURL utility.

```bash
curl -L -X POST 'http://localhost:8212/v1/api/unban' \
-H 'Content-Type: application/json' \
--data-raw '{
  "userid": "steam_00000000000000000"
}'
```

--------------------------------

### Retrieve Server Metrics via cURL

Source: https://docs.palworldgame.com/api/rest-api/metrics

Example command to request server metrics using cURL.

```bash
curl -L -X GET 'http://localhost:8212/v1/api/metrics' \
-H 'Accept: application/json'
```

--------------------------------

### Shutdown Server via cURL

Source: https://docs.palworldgame.com/api/rest-api/shutdown

Example command to trigger the server shutdown using cURL.

```bash
curl -L -X POST 'http://localhost:8212/v1/api/shutdown' \
-H 'Content-Type: application/json' \
--data-raw '{
  "waittime": 30,
  "message": "Server will shutdown in 10 seconds."
}'
```

--------------------------------

### GET http://localhost:8212/v1/api/metrics

Source: https://docs.palworldgame.com/api/rest-api/metrics

Retrieves the current server metrics including FPS, player counts, and uptime.

```APIDOC
## GET http://localhost:8212/v1/api/metrics

### Description
Retrieves the current server metrics, including performance data and player statistics.

### Method
GET

### Endpoint
http://localhost:8212/v1/api/metrics

### Response
#### Success Response (200)
- **serverfps** (integer) - The server FPS.
- **currentplayernum** (integer) - The number of current players.
- **serverframetime** (number) - Server frame time (ms).
- **maxplayernum** (integer) - The maximum number of players.
- **uptime** (integer) - The server uptime in seconds.
- **basecampnum** (integer) - The number of base camps in the server.
- **days** (integer) - The server days of in-game.

#### Response Example
{
  "serverfps": 57,
  "currentplayernum": 10,
  "serverframetime": 16.7671,
  "maxplayernum": 32,
  "uptime": 3600,
  "basecampnum": 32,
  "days": 1
}
```

--------------------------------

### Server Metrics Response Schema

Source: https://docs.palworldgame.com/api/rest-api/metrics

Example JSON response structure containing server performance metrics.

```json
{
  "serverfps": 57,
  "currentplayernum": 10,
  "serverframetime": 16.7671,
  "maxplayernum": 32,
  "uptime": 3600,
  "basecampnum": 32,
  "days": 1
}
```

--------------------------------

### Get World Actor Snapshot Endpoint

Source: https://docs.palworldgame.com/api/rest-api/game-data

The base endpoint for retrieving the current world state.

```http
GET 
## http://localhost:8212/v1/api/game-data
```

--------------------------------

### Player List Response Schema

Source: https://docs.palworldgame.com/api/rest-api/players

Example JSON response structure containing an array of player objects.

```json
{
  "players": [
    {
      "name": "PalUser",
      "accountName": "paluser",
      "playerId": "AFAFD830000000000000000000000000",
      "userId": "steam_00000000000000000",
      "ip": "127.0.0.1",
      "ping": 3.14,
      "location_x": 123.45,
      "location_y": 67.89,
      "level": 1,
      "building_count": 119
    }
  ]
}
```

--------------------------------

### Game Data Snapshot JSON Response

Source: https://docs.palworldgame.com/api/rest-api/game-data

Example structure of the JSON response returned by the game-data endpoint.

```json
{
  "Time": "2026-06-17 13:00:40",
  "FPS": 91.71,
  "AverageFPS": 33.78,
  "ActorData": [
    {},
    {}
  ]
}
```

--------------------------------

### GET /v1/api/players

Source: https://docs.palworldgame.com/api/rest-api/players

Retrieves a list of all players currently connected to the server.

```APIDOC
## GET /v1/api/players

### Description
Retrieves the list of players currently connected to the server.

### Method
GET

### Endpoint
http://localhost:8212/v1/api/players

### Response
#### Success Response (200)
- **players** (object[]) - An array of player objects containing:
  - **name** (string) - The player name.
  - **accountName** (string) - User's platform account name.
  - **playerId** (string) - The player ID.
  - **userId** (string) - The user ID.
  - **ip** (string) - The player IP address.
  - **ping** (number) - The player ping.
  - **location_x** (number) - The player location X.
  - **location_y** (number) - The player location Y.
  - **level** (integer) - Current player game level.
  - **building_count** (integer) - The number of buildings owned by the player.

#### Response Example
{
  "players": [
    {
      "name": "PalUser",
      "accountName": "paluser",
      "playerId": "AFAFD830000000000000000000000000",
      "userId": "steam_00000000000000000",
      "ip": "127.0.0.1",
      "ping": 3.14,
      "location_x": 123.45,
      "location_y": 67.89,
      "level": 1,
      "building_count": 119
    }
  ]
}
```

--------------------------------

### GET /v1/api/game-data

Source: https://docs.palworldgame.com/api/rest-api/game-data

Retrieves a snapshot object containing metadata and a list of all actors currently in the world.

```APIDOC
## GET /v1/api/game-data

### Description
Returns a snapshot object with metadata containing a list of all actors on the world at the moment of the call.

### Method
GET

### Endpoint
http://localhost:8212/v1/api/game-data

### Response
#### Success Response (200)
- **Time** (string) - Snapshot timestamp ("YYYY-MM-DD HH:MM:SS", server local time)
- **FPS** (float) - Instantaneous server FPS
- **AverageFPS** (float) - Average server FPS
- **ActorData** (array) - Array of actors (Character / PalBox)

#### Response Example
{
  "Time": "2026-06-17 13:00:40",
  "FPS": 91.71,
  "AverageFPS": 33.78,
  "ActorData": [
    {},
    {}
  ]
}
```

--------------------------------

### Server Information Response Schema

Source: https://docs.palworldgame.com/api/rest-api/info

Example JSON response structure returned by the server info endpoint.

```json
{
  "version": "v0.1.5.0",
  "servername": "Palworld example Server",
  "description": "This is a Palworld server.",
  "worldguid": "A7E97BAA767DB9029EF013BB71E993A0"
}
```

--------------------------------

### Copy Default Configuration for Windows

Source: https://docs.palworldgame.com/settings-and-operation/configuration

Use this command to initialize the server configuration file on Windows systems by copying the default settings.

```powershell
Copy-Item steamapps\common\PalServer\DefaultPalWorldSettings.ini steamapps\common\PalServer\Pal\Saved\Config\WindowsServer\PalWorldSettings.ini  
```

--------------------------------

### Copy Default Configuration for Linux

Source: https://docs.palworldgame.com/settings-and-operation/configuration

Use this command to initialize the server configuration file on Linux systems by copying the default settings.

```bash
cp steamapps/common/PalServer/DefaultPalWorldSettings.ini steamapps/common/PalServer/Pal/Saved/Config/LinuxServer/PalWorldSettings.ini  
```

--------------------------------

### Enable PvP in Server Settings

Source: https://docs.palworldgame.com/settings-and-operation/pvp

Set these three parameters to True in the server configuration file to activate PvP functionality.

```ini
bIsPvP=True  
bEnablePlayerToPlayerDamage=True  
bEnableDefenseOtherGuildPlayer=True  
```

--------------------------------

### Configure Windows Community Server

Source: https://docs.palworldgame.com/getting-started/deploy-community-server

Add the public lobby flag to the startup arguments for Windows-based Palworld servers.

```bash
PalServer.exe -publiclobby  
```

--------------------------------

### Configure Linux Community Server

Source: https://docs.palworldgame.com/getting-started/deploy-community-server

Add the public lobby flag to the startup arguments for Linux-based Palworld servers.

```bash
./PalServer.sh -publiclobby  
```

--------------------------------

### Download Dedicated Server via SteamCMD

Source: https://docs.palworldgame.com/getting-started/deploy-dedicated-server

Use this command to download or update the Palworld dedicated server files anonymously.

```bash
steamcmd +login anonymous +app_update 2394010 validate +quit  
```

--------------------------------

### Default Server Directory Structure

Source: https://docs.palworldgame.com/settings-and-operation/mod

The standard file layout for a dedicated server, showing where to place mod files and the Info.json configuration.

```text
.\PalServer.exe  
.\Mods\PalModSettings.ini  
.\Mods\Workshop\[any folder name]\Info.json  

```

--------------------------------

### Respawn Settings

Source: https://docs.palworldgame.com/settings-and-operation/pvp

Configures respawn delays and penalty scaling based on death frequency.

```ini
BlockRespawnTime=5.0  
RespawnPenaltyDurationThreshold=1800.0  
RespawnPenaltyTimeScale=2.0  
```

--------------------------------

### PvP Rewards Settings

Source: https://docs.palworldgame.com/settings-and-operation/pvp

Configures custom PvP item drops and map display settings for tracking rewards.

```ini
bAdditionalDropItemWhenPlayerKillingInPvPMode=True  
AdditionalDropItemWhenPlayerKillingInPvPMode=PlayerDropItem("Champion's Emblem"）  
AdditionalDropItemNumWhenPlayerKillingInPvPMode=1.0  
```

```ini
bDisplayPvPItemNumOnWorldMap_BaseCamp=True  
bDisplayPvPItemNumOnWorldMap_Player=True  
```

--------------------------------

### Configure DenyTechnologyList

Source: https://docs.palworldgame.com/settings-and-operation/configuration

Specify a list of technology IDs to disable in the game.

```text
DenyTechnologyList=("PALBOX", "RepairBench"))
```

--------------------------------

### Retrieve Server Settings Endpoint

Source: https://docs.palworldgame.com/api/rest-api/settings

The base endpoint for fetching server configuration data.

```http
GET 
## http://localhost:8212/v1/api/settings
```

--------------------------------

### Configure PalModSettings.ini

Source: https://docs.palworldgame.com/settings-and-operation/mod

The configuration file used to enable mods globally and specify which packages to load.

```ini
[PalModSettings]  
bGlobalEnableMod=true  
ActiveModList=GamingCattiva  
ActiveModList=FarmingQuivern  
# WorkshopRootDir=C:\Program Files (x86)\Steam\steamapps\workshop\content\1623730  

```

--------------------------------

### Default Client Workshop Path

Source: https://docs.palworldgame.com/settings-and-operation/mod

The default location where Steam stores workshop content on the game client.

```text
C:\Program Files (x86)\Steam\steamapps\workshop\content\1623730  

```

--------------------------------

### POST /v1/api/announce

Source: https://docs.palworldgame.com/api/rest-api/announce

Sends an announcement message to the server.

```APIDOC
## POST /v1/api/announce

### Description
Announce a message to the game server.

### Method
POST

### Endpoint
http://localhost:8212/v1/api/announce

### Parameters
#### Request Body
- **message** (string) - Required - The message to announce.

### Request Example
{
  "message": "Hello, Palworld!"
}

### Response
#### Success Response (200)
- The message was announced.

#### Error Responses
- 400: Bad request.
- 401: Unauthorized.
```

--------------------------------

### Base Area Visualization

Source: https://docs.palworldgame.com/settings-and-operation/pvp

Controls the visibility of other players' base areas.

```ini
bInvisibleOtherGuildBaseCampAreaFX=False  
```

--------------------------------

### Announce Message via CURL

Source: https://docs.palworldgame.com/api/rest-api/announce

Sends a POST request to the announce endpoint using the curl command-line tool.

```bash
curl -L -X POST 'http://localhost:8212/v1/api/announce' \
-H 'Content-Type: application/json' \
--data-raw '{
  "message": "Hello, Palworld!"
}'
```

--------------------------------

### Guild Settings

Source: https://docs.palworldgame.com/settings-and-operation/pvp

Limits the number of players per guild and the number of bases allowed to reduce server load.

```ini
GuildPlayerMaxNum=4  
BaseCampMaxNumInGuild=2  
```

--------------------------------

### POST http://localhost:8212/v1/api/kick

Source: https://docs.palworldgame.com/api/rest-api/kick

Kicks a player from the server using their unique user ID.

```APIDOC
## POST http://localhost:8212/v1/api/kick

### Description
Kicks a player from the server. Requires a JSON request body containing the player's ID.

### Method
POST

### Endpoint
http://localhost:8212/v1/api/kick

### Parameters
#### Request Body
- **userid** (string) - Required - The player ID to kick.
- **message** (string) - Optional - The message to display to the kicked player.

### Request Example
{
  "userid": "steam_00000000000000000",
  "message": "You are kicked."
}

### Response
#### Success Response (200)
- The player was kicked.

#### Error Responses
- 400: Bad request.
- 401: Unauthorized.
```

--------------------------------

### Kick Player via cURL

Source: https://docs.palworldgame.com/api/rest-api/kick

Sends a POST request to the kick endpoint using cURL with the required JSON body.

```bash
curl -L -X POST 'http://localhost:8212/v1/api/kick' \
-H 'Content-Type: application/json' \
--data-raw '{
  "userid": "steam_00000000000000000",
  "message": "You are kicked."
}'
```

--------------------------------

### Retrieve Server Information Endpoint

Source: https://docs.palworldgame.com/api/rest-api/info

The base endpoint for fetching server metadata.

```http
GET 
## http://localhost:8212/v1/api/info
```

--------------------------------

### Guild Rejoin Cooldown

Source: https://docs.palworldgame.com/settings-and-operation/pvp

Sets the time in minutes before a player can rejoin a guild after leaving.

```ini
GuildRejoinCooldownMinutes=60.0  
```

--------------------------------

### Death Penalty Settings

Source: https://docs.palworldgame.com/settings-and-operation/pvp

Configures item and Pal drops upon death, including whether other players can loot them.

```ini
DeathPenalty=All  
bCanPickupOtherGuildDeathPenaltyDrop=True  
```

--------------------------------

### POST /v1/api/stop

Source: https://docs.palworldgame.com/api/rest-api/stop

Force stop the server.

```APIDOC
## POST /v1/api/stop

### Description
Force stop the server.

### Method
POST

### Endpoint
http://localhost:8212/v1/api/stop

### Response
#### Success Response (200)
- The server force stopped.

#### Error Responses
- 400: Request error.
- 401: Unauthorized.

### Request Example
```bash
curl -L -X POST 'http://localhost:8212/v1/api/stop'
```
```

--------------------------------

### Structure Count Limit

Source: https://docs.palworldgame.com/settings-and-operation/pvp

Sets the maximum number of structures a player can build.

```ini
MaxBuildingLimitNum=1000  
```

--------------------------------

### Server Settings JSON Schema

Source: https://docs.palworldgame.com/api/rest-api/settings

The structure of the JSON object returned by the server settings endpoint.

```json
{
  "Difficulty": "string",
  "DayTimeSpeedRate": 0,
  "NightTimeSpeedRate": 0,
  "ExpRate": 0,
  "PalCaptureRate": 0,
  "PalSpawnNumRate": 0,
  "PalDamageRateAttack": 0,
  "PalDamageRateDefense": 0,
  "PlayerDamageRateAttack": 0,
  "PlayerDamageRateDefense": 0,
  "PlayerStomachDecreaceRate": 0,
  "PlayerStaminaDecreaceRate": 0,
  "PlayerAutoHPRegeneRate": 0,
  "PlayerAutoHpRegeneRateInSleep": 0,
  "PalStomachDecreaceRate": 0,
  "PalStaminaDecreaceRate": 0,
  "PalAutoHPRegeneRate": 0,
  "PalAutoHpRegeneRateInSleep": 0,
  "BuildObjectDamageRate": 0,
  "BuildObjectDeteriorationDamageRate": 0,
  "CollectionDropRate": 0,
  "CollectionObjectHpRate": 0,
  "CollectionObjectRespawnSpeedRate": 0,
  "EnemyDropItemRate": 0,
  "DeathPenalty": "string",
  "bEnablePlayerToPlayerDamage": true,
  "bEnableFriendlyFire": true,
  "bEnableInvaderEnemy": true,
  "bActiveUNKO": true,
  "bEnableAimAssistPad": true,
  "bEnableAimAssistKeyboard": true,
  "DropItemMaxNum": 0,
  "DropItemMaxNum_UNKO": 0,
  "BaseCampMaxNum": 0,
  "BaseCampWorkerMaxNum": 0,
  "DropItemAliveMaxHours": 0,
  "bAutoResetGuildNoOnlinePlayers": true,
  "AutoResetGuildTimeNoOnlinePlayers": 0,
  "GuildPlayerMaxNum": 0,
  "PalEggDefaultHatchingTime": 0,
  "WorkSpeedRate": 0,
  "bIsMultiplay": true,
  "bIsPvP": true,
  "bCanPickupOtherGuildDeathPenaltyDrop": true,
  "bEnableNonLoginPenalty": true,
  "bEnableFastTravel": true,
  "bIsStartLocationSelectByMap": true,
  "bExistPlayerAfterLogout": true,
  "bEnableDefenseOtherGuildPlayer": true,
  "CoopPlayerMaxNum": 0,
  "ServerPlayerMaxNum": 0,
  "ServerName": "string",
  "ServerDescription": "string",
  "PublicPort": 0,
  "PublicIP": "string",
  "RCONEnabled": true,
  "RCONPort": 0,
  "Region": "string",
  "bUseAuth": true,
  "BanListURL": "string",
  "RESTAPIEnabled": true,
  "RESTAPIPort": 0,
  "bShowPlayerList": true,
  "AllowConnectPlatform": "string",
  "bIsUseBackupSaveData": true,
  "LogFormatType": "string"
}
```

--------------------------------

### Ban Player via cURL

Source: https://docs.palworldgame.com/api/rest-api/ban

Use this cURL command to send a POST request to the ban endpoint with the required JSON body.

```bash
curl -L -X POST 'http://localhost:8212/v1/api/ban' \
-H 'Content-Type: application/json' \
--data-raw '{
  "userid": "steam_00000000000000000",
  "message": "You are banned."
}'
```

--------------------------------

### Buildable Area Restrictions

Source: https://docs.palworldgame.com/settings-and-operation/pvp

Prevents building in critical locations like spawn points.

```ini
bBuildAreaLimit=True  
```

--------------------------------

### POST /v1/api/shutdown

Source: https://docs.palworldgame.com/api/rest-api/shutdown

Triggers a shutdown of the server after a specified wait time, optionally displaying a message to users.

```APIDOC
## POST /v1/api/shutdown

### Description
Shutdown the server after a specified wait time.

### Method
POST

### Endpoint
http://localhost:8212/v1/api/shutdown

### Request Body
- **waittime** (integer) - Required - The time to wait before shutting down the server.
- **message** (string) - Optional - The message to display before shutting down the server.

### Request Example
{
  "waittime": 30,
  "message": "Server will shutdown in 10 seconds."
}

### Response
#### Success Response (200)
- The server will shutdown.

#### Error Responses
- 400: Bad request.
- 401: Unauthorized.
```

--------------------------------

### Force Stop Server via cURL

Source: https://docs.palworldgame.com/api/rest-api/stop

Use this command to send a POST request to the stop endpoint using cURL.

```bash
curl -L -X POST 'http://localhost:8212/v1/api/stop'
```

--------------------------------

### Save World Request

Source: https://docs.palworldgame.com/api/rest-api/save

Endpoint URL for triggering a world save operation.

```http
POST 
## http://localhost:8212/v1/api/save
```

--------------------------------

### Stop Server Endpoint

Source: https://docs.palworldgame.com/api/rest-api/stop

The endpoint path for sending a force stop command to the server.

```http
POST 
## http://localhost:8212/v1/api/stop
```

--------------------------------

### POST /v1/api/save

Source: https://docs.palworldgame.com/api/rest-api/save

Triggers a save operation for the current world state.

```APIDOC
## POST /v1/api/save

### Description
Saves the current world state.

### Method
POST

### Endpoint
http://localhost:8212/v1/api/save

### Response
#### Success Response (200)
- Successfully saved the world.

#### Error Responses
- 400: Request error.
- 401: Unauthorized.

### Request Example
```bash
curl -L -X POST 'http://localhost:8212/v1/api/save'
```
```

--------------------------------

### Retrieve Server Metrics Endpoint

Source: https://docs.palworldgame.com/api/rest-api/metrics

The endpoint used to fetch current server performance data.

```http
GET 
## http://localhost:8212/v1/api/metrics
```

--------------------------------

### Individually disable technologies

Source: https://docs.palworldgame.com/settings-and-operation/pvp

Restricts specific technologies that impact PvP balance, such as grappling guns and guild chests.

```ini
DenyTechnologyList=("SkillUnlock_JetDragon", "SkillUnlock_IceHorse", "SkillUnlock_IceHorse_Dark", "SkillUnlock_SaintCentaur", "SkillUnlock_BlackCentaur", "SkillUnlock_DarkMechaDragon", "SkillUnlock_PoseidonOrca", "GrapplingGun", "GrapplingGun2", "GrapplingGun3", "GrapplingGun4", "GrapplingGun5", "GuildChest")  
```

--------------------------------

### POST /v1/api/unban

Source: https://docs.palworldgame.com/api/rest-api/unban

Unbans a player from the server by providing their user ID in the request body.

```APIDOC
## POST /v1/api/unban

### Description
Unban a player from the server.

### Method
POST

### Endpoint
http://localhost:8212/v1/api/unban

### Parameters
#### Request Body
- **userid** (string) - Required - The player ID to unban.

### Request Example
{
  "userid": "steam_00000000000000000"
}

### Response
#### Success Response (200)
- The player was unbanned.

#### Error Responses
- 400: Bad request.
- 401: Unauthorized.
```

--------------------------------

### POST /v1/api/ban

Source: https://docs.palworldgame.com/api/rest-api/ban

Bans a player from the server using their unique user ID.

```APIDOC
## POST /v1/api/ban

### Description
Bans a player from the game server.

### Method
POST

### Endpoint
http://localhost:8212/v1/api/ban

### Parameters
#### Request Body
- **userid** (string) - Required - The player ID to ban.
- **message** (string) - Optional - The message to display to the banned player.

### Request Example
{
  "userid": "steam_00000000000000000",
  "message": "You are banned."
}

### Response
#### Success Response (200)
- The player was banned.

#### Error Responses
- 400: Bad request.
- 401: Unauthorized.
```

--------------------------------

### Kick Player Request Body

Source: https://docs.palworldgame.com/api/rest-api/kick

The JSON structure required for the request body when calling the kick endpoint.

```json
{
  "userid": "steam_00000000000000000",
  "message": "You are kicked."
}
```

--------------------------------

### Unban Player Request Body

Source: https://docs.palworldgame.com/api/rest-api/unban

The required JSON structure for the unban request body.

```json
{
  "userid": "steam_00000000000000000"
}
```

--------------------------------

### Shutdown Server Request

Source: https://docs.palworldgame.com/api/rest-api/shutdown

The endpoint requires a POST request to the shutdown path with a JSON body specifying the wait time and message.

```http
POST 
http://localhost:8212/v1/api/shutdown
```

--------------------------------

### Unban Player Endpoint URL

Source: https://docs.palworldgame.com/api/rest-api/unban

The endpoint used to perform the unban action via a POST request.

```http
POST 
## http://localhost:8212/v1/api/unban
```

--------------------------------

### Announce Message Request Body

Source: https://docs.palworldgame.com/api/rest-api/announce

The JSON structure required for the request body when calling the announce endpoint.

```json
{
  "message": "Hello, Palworld!"
}
```

--------------------------------

### Ban Player Request Body

Source: https://docs.palworldgame.com/api/rest-api/ban

The JSON structure required for the request body when banning a player.

```json
{
  "userid": "steam_00000000000000000",
  "message": "You are banned."
}
```

--------------------------------

### Fast Travel Restrictions

Source: https://docs.palworldgame.com/settings-and-operation/pvp

Limits or disables fast travel to prevent players from avoiding combat.

```ini
bEnableFastTravel=True  
bEnableFastTravelOnlyBaseCamp=True  
```

--------------------------------

### Shutdown Request Body

Source: https://docs.palworldgame.com/api/rest-api/shutdown

The JSON payload required for the shutdown request.

```json
{
  "waittime": 30,
  "message": "Server will shutdown in 10 seconds."
}
```

--------------------------------

### Block player stat allocation

Source: https://docs.palworldgame.com/settings-and-operation/pvp

Disables the ability for players to increase HP or Attack stats.

```ini
bAllowEnhanceStat_Health=False  
bAllowEnhanceStat_Attack=False  
```

--------------------------------

### Prohibit escape combat via Logout

Source: https://docs.palworldgame.com/settings-and-operation/pvp

Forces players to remain in the world as sleeping characters upon logout to prevent combat evasion.

```ini
bExistPlayerAfterLogout=True  
```

--------------------------------

### Disable Gamepad Aim Assist

Source: https://docs.palworldgame.com/settings-and-operation/pvp

Toggles aim assist functionality for controller users.

```ini
bEnableAimAssistPad=True  
```
Tokens:
Raw