README.md

PZ Admin is a Windows and Linux desktop application for managing Project Zomboid servers with RCON.

Installation

Download from the website or go to the releases page and download the matching binary for your platform. Windows(amd64, arm64) and Linux(amd64) are supported.

Table of Contents

• Screenshots
• Features
• Development
• Frontend Scripts
• Technologies
• License

Screenshots

Expand the section below to view screenshots.

Click to view screenshots

Manage your server.

View and manage your players.

Modify and save server options.

Interact with your server directly via an RCON terminal.

Spawn vehicles with a catalog.

Add items with an item catalog.

Add xp to players with custom skills and levels.

Set player access level.

Message Editor

Item Browser

Vehicle Browser

Features

Server Management

• RCON terminal for remote console access.
• Modify, import, and export server options.
• Save world, stop server.
• Send server-wide messages.
• Weather controls: Start/stop rain and weather.
• Trigger random events like choppers, gunshots, lightning, and thunder.

Player Management

• View and manage player list.
• Add XP, items, or vehicles to players.
• Adjust access levels, ban/unban, kick, or teleport players.
• Add/remove players to/from the whitelist.
• Create hordes, lightning or thunder on specific players.

Tools

• Message editor, item browser and vehicle browser available as standalone tools.

Development

Pre-requisites

Before starting development, ensure you have the following installed:

1. Install NodeJS: NodeJS installation guide.
2. Install Yarn: Yarn installation guide.
3. Install Go: Go installation guide.
4. Install Wails: Wails installation guide.

Development or Building

1. Clone the repository:

   git clone https://github.com/beyenilmez/pz-admin.git
   

2. Navigate to the project directory:

   cd pz-admin
   

3. Run in dev mode:

   wails dev
   

   or build the application:

   wails build
   

Frontend Scripts

• yarn vehicles: Updates the src/assets/vehicles.json file with the new vehicles from public/vehicles folder.

• yarn items: Downloads item images to public/items and updates the src/assets/items.json file.

• yarn convert-item-translations: Converts translations for items into JSON.

  Usage: yarn convert-item-translations {lang} {encoding}

  Example: game-translations/{lang}.txt → public/locales/{lang}/items.json.

  Item translation files are located in: C:\Program Files (x86)\Steam\steamapps\common\ProjectZomboid\media\lua\shared\Translate\{lang}\ItemName_{lang}.txt

Technologies

• Backend: Go, Wails, RCON
• Frontend: React, TailwindCSS, shadcnUI
• Translation: i18next

License

Distributed under the MIT License. See LICENSE for more information.