78 lines
1.4 KiB
Markdown
78 lines
1.4 KiB
Markdown
# Q3A RCON Dashboard
|
|
|
|
A desktop application for administering Quake 3 Arena servers via RCON protocol. Built with Electron.
|
|
|
|
## Features
|
|
|
|
- Multi-server management with tabbed interface
|
|
- Quick-action buttons for common commands (Status, Kick, Say, Map, Ban, etc.)
|
|
- Three switchable themes: Terminal, Dark, Light
|
|
- Server configurations persisted to JSON
|
|
- Auto-open saved servers on startup
|
|
|
|
## Requirements
|
|
|
|
- Node.js 18+
|
|
- npm 9+
|
|
|
|
## Installation
|
|
|
|
```bash
|
|
npm install
|
|
```
|
|
|
|
## Building
|
|
|
|
### Linux (AppImage)
|
|
|
|
```bash
|
|
npm run build:linux
|
|
```
|
|
|
|
Output: `dist/Q3A RCON Dashboard-1.0.0.AppImage`
|
|
|
|
### Windows (Portable EXE)
|
|
|
|
On a Windows machine:
|
|
|
|
```cmd
|
|
npm run build:win
|
|
```
|
|
|
|
Output: `dist/Q3A RCON Dashboard-1.0.0.exe`
|
|
|
|
### Build Both
|
|
|
|
```bash
|
|
npm run build
|
|
```
|
|
|
|
## Running
|
|
|
|
```bash
|
|
npm start
|
|
```
|
|
|
|
## RCON Commands
|
|
|
|
| Command | Description |
|
|
|---------|-------------|
|
|
| `status` | Player list with scores and pings |
|
|
| `serverinfo` | Server settings (gametype, fraglimit, etc.) |
|
|
| `systeminfo` | System info (OS, CPU) |
|
|
| `kick <name>` | Kick player (or "all", "allbots") |
|
|
| `kicknum <num>` | Kick by slot number |
|
|
| `say <msg>` | Broadcast to all players |
|
|
| `map <name>` | Change map (e.g., q3dm1) |
|
|
| `banaddr <ip>` | Ban IP address |
|
|
| `listbans` | List all bans |
|
|
| `rehashbans` | Reload bans from file |
|
|
| `flushbans` | Delete all bans |
|
|
|
|
See the in-app Reference button for full command list.
|
|
|
|
## Tested Servers
|
|
|
|
- ioquake3
|
|
- Q3ALight
|
|
- Other Q3A-compatible engines |