PalScout

PalScout

PalScout is an AI-powered chatbot and moderation tool for Palworld dedicated servers. Players can chat with an AI directly in-game, and its answers are grounded in live game data — your actual HP, level, position, and nearby creatures — not just generic chat.

Where to get it

• GitHub Releases — source code and the standalone.exe, no Python installation required

-

-

• Steam Workshop — hosts the companion PalScoutChatLogger mod only. The full bot isn't distributable through Workshop (it depends on an external application, which Workshop's package format doesn't support) — get PalScout itself from one of the links above.

Features

• AI chat, grounded in real game state — ask questions in-game and get answers that reference your actual HP, level, guild, and nearby creatures with real distances
• Multi-provider AI fallback — automatically switches between AI providers if one is down or rate-limited, so PalScout stays online
• Web and YouTube search — automatically searches when a question needs current info (weather, news, scores, etc.), or on demand with!search!youtube
• Full moderation system — warnings that auto-escalate to a kick, plus kick/ban commands, all logged
• Admin-only moderation commands — verified by Steam ID, so display names can't be spoofed to gain admin access
• Admin protection — admins can't be kicked, banned, or warned through the bot, even by other admins
• Anti-spam cooldown — toggleable, prevents command spam; admins are always exempt
• Optional auto-moderation — toggleable chat filter for banned words, excessive caps, and spam, off by default
• Permanent memory — save notes for the AI to remember with!ai remember
• Optional Discord bridge — run the same commands from Discord, not just in-game
• Web dashboard — a local browser interface (optional, password-protected) to view live status, manage players, review warnings and bans, tune AI providers, edit settings, and customize the dashboard's look — no more editing config.txt by hand for everyday admin tasks
• No RCON dependency — built entirely on Palworld's REST API, since RCON is being phased out by the developers

Requirements

• A running Palworld dedicated server with RESTAPIEnabled=True set in PalWorldSettings.ini, launched with the -enable-gamedata-api flag
• UE4SS installed on the server, plus PalScout's own chat-logging mod (included in this repo under PalScoutChatLogger/ — required because Palworld's REST API can only send chat, not read it)
• At least one AI provider API key (a free tier from Groq is enough to get started)
• Python 3.10+ — only if running from source. Not needed if using the prebuilt.exe.

Installation

Option A — prebuilt.exe (recommended, no Python needed)

• Download PalScout.exe from the latest release
• Follow steps 3–5 below to install UE4SS and the chat-logging mod
• Run PalScout.exe once to generate a config.txt template next to it
• Fill in config.txt, then run PalScout.exe again

Option B — from source

• Clone or download this repository into its own folder
• Install dependencies:

pip install requests groq openai discord.py duckduckgo-search flask

• Install UE4SS on your server if you haven't already (unzip into Pal\Binaries\Win64)
• Copy the PalScoutChatLogger folder from this repo into your server's Pal\Binaries\Win64\Mods\ folder. The folder structure should look like:

Mods\PalScoutChatLogger\

├── enabled.txt

└── Scripts\

└── main.lua

• Launch the server with the -enable-gamedata-api flag and check the UE4SS console for [PalScoutChatLogger] Loaded and hooked into chat. to confirm it loaded
• Run the bot once to generate a config file:

python bot.py

• Open the generated config.txt and fill in your real values (server admin password, at least one AI API key, the path to PalScoutChat.log — created next to the mod once it's running — and your admin Steam ID)
• Run the bot again:

python bot.py

Configuration

All settings live in config.txt, created automat