/palworld-admin

Administrate your dedicated Palworld server right from the web browser

Primary LanguageTypeScriptGNU Affero General Public License v3.0AGPL-3.0

Palworld Admin

Administrate your dedicated Palworld server right from the web browser. It uses RCON to communicate with the server.

Why ?

All the RCON administration tool I found were either pretty basic or only worked on Windows. I wanted a tool that I can access from anywhere to manage my dedicated Palworld server.

Features

  • Display the online player list
  • Kick/ban player from the player

More to come! See the issues for the roadmap.

Usage

Docker image

If you're using thijsvanloef/palworld-server-docker or jammsen/docker-palworld-dedicated-server image, you can easily add the palworld-admin to your docker compose configuration.

version: '3.9'
services:
  ...
  palworld-admin:
    container_name: palworld-admin
    hostname: palworld-admin
    image: thenaji27/palworld-admin:latest
    restart: unless-stopped
    ports:
      - "127.0.0.1:3000:2093"
    environment:
      - TZ=Europe/Paris
      - RCON_HOST=<palword server container name>
      - RCON_PORT=25575
      - RCON_PASSWORD=<password>

Development

Stack

Prerequisites

  • Bun v1.x
  • Node.js v20.x

Installation

Clone the repository and install the dependencies

git clone https://github.com/na-ji/palworld-admin.git
cd palworld-admin
bun install

Configuration

Copy the example configuration file and fill it

cp .env.example .env

Dev environment

bun run dev