Palworld Server Manager - Takaro

🦖 A free Palworld server manager — connect your Palworld dedicated server to the Takaro game server management platform for player management, teleports, in-game chat, and Discord.

🌟 Features

• Full v1 API Integration - All 11 Palworld REST API endpoints supported
• Console Commands - Run commands directly from Takaro's web console
• Real-time Player Tracking - Monitor player locations and activity
• WebSocket Connection - Instant server events and status updates
• Player Management - Ban, kick, and manage players by name
• Server Control - Save, shutdown, stop, and announce commands
• Chat Integration - In-game chat forwarding to Takaro/Discord (UE4SS mod)

📥 Installation

Prerequisites

• Palworld dedicated server with REST API enabled
• Node.js 18 or higher
• Takaro account and server registration token

Quick Start

1. Enable Palworld REST API

   Edit your PalWorldSettings.ini:

   RESTAPIEnabled=True
   RESTAPIPort=8212
   AdminPassword=YourSecurePassword

2. Install Bridge

   Download the latest release (Palworld-Bridge-vX.X.X.tar.gz from the Releases page) and extract it. The download includes everything: the prebuilt bridge, a ready-to-edit TakaroConfig.txt, and the TakaroChat UE4SS mod. Then install dependencies:

   cd Palworld-Bridge
   npm install

   Building from source instead? git clone this repo, then npm install && npm run build.

3. Configure

   Create TakaroConfig.txt:

   # Takaro Connection
   SERVER_NAME=Give your server a name
   REGISTRATION_TOKEN=YourRegistrationToken
   
   # Palworld Server Settings
   PALWORLD_HOST=127.0.0.1
   PALWORLD_PORT=8212
   PALWORLD_USERNAME=admin
   PALWORLD_PASSWORD=YourAdminPassword

4. Start Bridge

   npm start
   # Or with PM2 for production:
   pm2 start dist/index.js --name palworld-bridge

💬 Chat Integration (Optional)

The TakaroChat UE4SS mod enables real-time chat forwarding from Palworld to Takaro and Discord.

Prerequisites

• UE4SS (Palworld-specific build) - Download UE4SS-Palworld.zip from Okaetsu's RE-UE4SS experimental-palworld release
  • ⚠️ Do NOT use the generic/mainline UE4SS — since Palworld patch 0.4.1.5 the engine changed and only the Palworld-specific build works. The generic build will crash the server on startup.
  • If you previously installed another UE4SS, delete the old dwmapi.dll and ue4ss folder from Pal\Binaries\Win64\ before installing this one.

Installation Steps

1. Install UE4SS

   a. Download UE4SS from the link above

   b. Extract the ZIP file

   c. Copy these files to your Palworld server directory PalServer\Pal\Binaries\Win64\:

   • dwmapi.dll
   • UE4SS.dll
   • UE4SS-settings.ini
   • The entire Mods folder

2. Install TakaroChat Mod

   a. Copy the TakaroChat folder (included in the release download / this repository) to:

   PalServer\Pal\Binaries\Win64\ue4ss\Mods\TakaroChat\
   

   b. Your directory structure should look like:

   PalServer\Pal\Binaries\Win64\
   └── ue4ss\
       ├── UE4SS.dll
       ├── UE4SS-settings.ini
       └── Mods\
           └── TakaroChat\
               ├── enabled.txt
               └── Scripts\
                   ├── main.lua
                   └── config.lua
   

3. Configure TakaroChat

   Edit TakaroChat/Scripts/config.lua:

   -- Bridge Connection
   config.BridgeURL = "http://localhost:3001/chat"  -- Bridge endpoint (default 3001)
   config.EnableBridge = true
   
   -- Chat Categories (Palworld chat types)
   -- 1 = Say (local), 2 = Guild, 3 = Global
   config.SendCategories = {1, 2, 3}  -- Which categories to send

4. Restart Palworld Server

   Stop and start your Palworld server to load UE4SS and the mod.

Features

• ✅ Game chat → Takaro platform → Discord
• ✅ Discord → Takaro → Game chat relay
• ✅ Player connect/disconnect events
• ✅ Support for Say, Guild, and Global chat channels
• ✅ Real-time event forwarding
• ✅ Configurable logging and filtering

Troubleshooting

UE4SS not loading:

• Ensure dwmapi.dll is in the Win64\ue4ss\ directory
• Check Windows didn't block the DLL (right-click → Properties → Unblock)
• Verify UE4SS version compatibility (3.0.0+)

Chat not appearing in Discord:

• Check bridge logs for connection from UE4SS mod
• Verify config.BridgeURL uses correct port (default: http://localhost:3001/chat)
• Ensure chat forwarding module is installed in Takaro

Mod not loading:

• Confirm enabled.txt exists in ue4ss\Mods\TakaroChat\ folder
• Check ue4ss\Mods\mods.txt includes TakaroChat entry
• Review UE4SS logs in ue4ss\UE4SS.log

See TakaroChat/README.md for detailed configuration options.

💻 Console Commands

Use these commands in the Takaro web console:

Command	Description
help	Show all available commands
players	List all online players
serverinfo	Get server information
metrics	Get server metrics
settings	Get server settings
announce <message>	Send announcement to all players
save	Save the world
shutdown [seconds] [message]	Shutdown server with countdown
stop	Stop server immediately
ban <player_name>	Ban a player by name
kick <player_name>	Kick a player by name
unban <steam_id>	Unban a player by Steam ID

🔌 Supported API Endpoints

GET Endpoints

• /v1/api/info - Server information
• /v1/api/players - Player list with locations
• /v1/api/settings - Server settings
• /v1/api/metrics - Server metrics

POST Endpoints

• /v1/api/announce - Send announcements
• /v1/api/save - Save world
• /v1/api/shutdown - Graceful shutdown
• /v1/api/stop - Immediate stop
• /v1/api/kick - Kick player
• /v1/api/ban - Ban player
• /v1/api/unban - Unban player

🔧 Configuration

TakaroConfig.txt

# Required: Takaro authentication
SERVER_NAME=Give your server a name
REGISTRATION_TOKEN=your-registration-token

# Optional: Palworld server connection (defaults shown)
PALWORLD_HOST=127.0.0.1
PALWORLD_PORT=8212
PALWORLD_USERNAME=admin
PALWORLD_PASSWORD=your-admin-password

Getting Takaro Tokens

1. Visit Takaro.io
2. Register your Palworld server
3. Copy the Identity Token and Registration Token
4. Add them to TakaroConfig.txt

📊 Monitoring

View bridge logs in real-time:

# If using npm start
tail -f palworld-bridge.log

# If using PM2
pm2 logs palworld-bridge

🐛 Troubleshooting

Bridge won't connect to Takaro

• Verify SERVER_NAME and REGISTRATION_TOKEN are correct
• Check bridge logs for connection errors
• Ensure internet connectivity

Can't connect to Palworld server

• Confirm REST API is enabled in PalWorldSettings.ini
• Verify AdminPassword matches between config and server
• Check server is running and port 8212 is accessible

Commands not working

• Ensure bridge is connected (check logs)
• Verify you're typing commands in Takaro console, not in-game
• Check command syntax with help command

🔄 Updates

To update the bridge to the latest version:

git pull
npm install
npm run build
pm2 restart palworld-bridge  # if using PM2

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

🔗 Links

• Documentation
• Takaro Platform
• Takaro Documentation
• Report Issues

💖 Support

If you find this project helpful, consider:

• ⭐ Starring the repository
• 🐛 Reporting bugs
• 💡 Suggesting new features
• 📖 Improving documentation

---

Created with ❤️ for the Palworld community