PalScout

DESCRIPTION

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

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 -- their actual HP, level,

position, and nearby creatures -- not generic chatbot responses.

It also includes a full moderation system, and an optional local web

dashboard for managing everything from a browser.

Full source code (this mod requires internet access to function --

it calls third-party AI provider APIs as its core feature, not as an

add-on): https://github.com/mona4891/PalScout-Chat-Bot

INSTALLATION INSTRUCTIONS

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

1. Enable the REST API on your Palworld dedicated server: in

PalWorldSettings.ini, set RESTAPIEnabled=True and RESTAPIPort=8212

inside the OptionSettings=(...) line, and launch the server with

the extra flag -enable-gamedata-api

2. Install UE4SS on your server: download from

https://github.com/UE4SS-RE/RE-UE4SS/releases and unzip into

Pal\Binaries\Win64\

3. Install the included PalScoutChatLogger mod: copy the

"PalScoutChatLogger" folder into Pal\Binaries\Win64\Mods\

This is required because Palworld's REST API can only send chat,

not read it -- this mod is what lets PalScout see what players

type in-game.

4. Run PalScout.exe once. It creates a config.txt file next to

itself, then stops so you can fill it in.

5. Open config.txt and fill in: at least one AI provider API key (a

free Groq key works, get one at https://console.groq.com/keys),

your server's admin password, the path to PalScoutChat.log

(appears in Pal\Binaries\Win64\ once the mod has run), and your

own Steam ID under ADMIN_STEAM_IDS.

6. Run PalScout.exe again. It should connect to your server and post

an online message in game chat.

Full step-by-step guide with troubleshooting is included in this

download (SETUP.txt) and on GitHub.

MAIN FEATURES

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

- AI chat grounded in real live game data (HP, level, guild,

position, nearby creatures with real distances) -- no other

Palworld server tool does this

- Multi-provider AI fallback (Groq, Cerebras, Mistral, OpenRouter, or

an optional local model) -- automatically switches providers if one

is down or rate-limited

- Full moderation system: warnings that auto-escalate to a kick,

kick, and ban -- all admin-only, verified by Steam ID so display

names can't be spoofed

- Admin protection: admins can't be kicked, banned, or warned through

the bot, even by other admins

- Web and YouTube search, automatic inside AI chat when a question

needs current info, or on demand

- Permanent memory -- players can save notes for the AI to remember

- Optional web dashboard: manage players, moderation, AI settings,

and bot configuration from a browser, including live status,

- Optional Discord bridge -- run the same commands from Discord

- Built entirely on Palworld's REST API rather than RCON, since RCON

is being phased out by the game's developers

REQUIREMENTS

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

- A Palworld dedicated server with RESTAPIEnabled=True and the

-enable-gamedata-api launch flag

- UE4SS (https://github.com/UE4SS-RE/RE-UE4SS/releases)

- At least one AI provider API key (a free Groq key is enough to get

started: https://console.groq.com/keys)

- Windows (the provided .exe is Windows-only; the Python source can

run on other platforms)

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

Thanks to the UE4SS team for making Palworld modding possible at all,

and to the Palworld dedicated server admin community for the existing

tools (PalCord, Palbot, and others) that proved this kind of server

tooling has a real audience.