Skip to content

Latest commit

 

History

History
91 lines (59 loc) · 3.87 KB

README.md

File metadata and controls

91 lines (59 loc) · 3.87 KB
Raw

PalBoard

Build Frontend Build Gateway Build Docker Image

A Palworld dashboard, built with Nuxt and Axum.

Screenshot of "Server Info"

Development

Docker Compose

docker compose build --build-arg VERSION=$(git describe --tags --always --broken)
docker compose up # `docker compose up gateway` for gateway only

Local

You need to install Node.js and Bun to build frontend and Rust to build gateway. Other Node.js package managers (e.g. npm, yarn) won't utilize bun.lockb and the build result may be different, so no guarantee.

# Allow .envrc if you use direnv
direnv allow
# or manually set environment variables, see .envrc for details

# Frontend
cd frontend
bun install
bun dev

# Gateway
cd gateway
RUST_LOG=debug cargo run

Features

SteamCMD Integration

If you are using the provided Docker compose file, installing or updating the game server is as simple as clicking a button on the web interface.

Screenshot of updating

There are also options to skip verification or updating only Steam itself if you are in a hurry.

Configuration Editor

A Monaco Editor is embedded to edit PalWorldSettings.ini on the web interface.

Screenshot of "Config Editor"

RCON Commands

Screenshot of "Player List"

See description on https://tech.palworldgame.com/server-commands.

Following table is corresponding to v0.1.2.0.

Command Frontend Gateway
/Shutdown {Seconds} {MessageText} 🚧 ✔️
/DoExit 🚧 ✔️
/Broadcast {MessageText} 🚧 ✔️
/KickPlayer {SteamID} ✔️ ✔️
/BanPlayer {SteamID} ✔️ ✔️
/TeleportToPlayer {SteamID} 🚫 🚫
/TeleportToMe {SteamID} 🚫 🚫
/ShowPlayers ✔️ ✔️
/Info ✔️ ✔️
/Save ✔️ ✔️

Symbols: ✔️(Complete), 🚧 (Work in Progress), ❌ (Incomplete), 🚫 (Impossible)

Teleport commands are not available because they need player context. If further update allows teleporting players from RCON context, they would be implemented.

Future Plans

  • Container management (enabling server start/restart)
  • Configuration management
    • Parsing DefaultPalWorldSettings.ini is implemented (see gateway/src/unreal_struct.rs)
    • A form-based editor for PalWorldSettings.ini is planned

License

SSPL-1.0. In short, you can use, modify, and distribute the software freely under the same license. However, if you provide the software as a service to others (which is the case if you are running game servers as a service commercially), you must release the complete source code, including all necessary components, under the SSPL. Contact me for alternative licensing.

Disclaimer

This project is not affiliated with Pocketpair, Inc.