Skip to content

Helbreath/admin-tool

Repository files navigation

Helbreath Admin Tool

Web-based remote administration tool for the Helbreath game server. Connects over WebSocket to provide real-time server control, player management, chat monitoring, and game world observation.

Prerequisites

  • Node.js 18+
  • A running Helbreath game server with WebSocket support (default ws://localhost:2848)
  • An account with admin privileges (admin level 1+)

Setup

npm install

Assets

The admin tool reuses sprites from the map-editor. Symlink them into public/:

ln -s "$(pwd)/../map-editor/public/assets" public/assets

Development

npm run dev

Opens at http://localhost:3001.

Production Build

npm run build

Output goes to dist/. Serve with any static file server -- the app uses relative paths (base: './').

npm run preview   # preview the production build locally

Usage

  1. Open the app in your browser
  2. Enter the server WebSocket URL (default ws://localhost:2848), username, and password
  3. The tool authenticates and enters admin mode automatically
  4. Use the sidebar to navigate between panels:
Panel Description
Dashboard Server status, online players, uptime
Chat Real-time chat monitor across all channels
Players Player list with inspect, kick, ban, teleport
Events Filterable event log (combat, deaths, logins, admin actions)
Data Item/NPC database browser
Maps Map viewer and configuration
Server Runtime server configuration
Performance Server performance metrics
Tasks Server task management
Spectator Live game world observation (PixiJS renderer)
Game Configs Edit server config files (items, npcs, magic, skills, etc.)

Admin Levels

Level Role
0 Player (no access)
1 Helper
2 Moderator
3 Game Master
4 Senior GM
5 Admin
6 Owner

Tech Stack

  • Vue 3 (Composition API + <script setup>)
  • Pinia for state management
  • Tailwind CSS for styling
  • Radix Vue for accessible UI primitives
  • PixiJS 8 for game world rendering (spectator mode)
  • Vite for dev server and builds

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages