https://github.com/samrocksc/herbst-mud
This is just a game that I'm working on
https://github.com/samrocksc/herbst-mud
Last synced: about 1 month ago
JSON representation
This is just a game that I'm working on
- Host: GitHub
- URL: https://github.com/samrocksc/herbst-mud
- Owner: samrocksc
- Created: 2025-11-02T11:29:29.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2026-05-28T06:11:59.000Z (about 1 month ago)
- Last Synced: 2026-05-28T08:09:11.980Z (about 1 month ago)
- Language: Go
- Size: 315 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 26
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Herbst MUD
A modern MUD (Multi-User Dungeon) game built with Go, TypeScript, and PostgreSQL.
## Features
- SSH-based multiplayer gameplay
- REST API for administration and game management
- Web-based admin panel
- PostgreSQL database with ent ORM
- Docker-based deployment
## Project Structure
- `herbst/` - SSH client implementation
- `server/` - REST API server
- `admin/` - Web-based admin panel
- `db/` - Database setup and migrations
- `docs/` - Documentation
- `features/` - Feature specifications
## Quick Start
1. Start all services:
```bash
make dev-all
```
2. Connect to the MUD via SSH:
```bash
ssh -p 4444 localhost
```
3. Access the admin panel at http://localhost:3000
4. Access the API at http://localhost:8080
## Database Setup
The project uses PostgreSQL with ent ORM. The database is automatically initialized when the servers start.
## Development
### Prerequisites
- Go 1.25+
- Node.js 18+
- Docker and Docker Compose
- PostgreSQL client
### Available Make Commands
- `make dev-all` - Start all services
- `make dev` - Start SSH and web servers
- `make start` - Start SSH server
- `make start-web` - Start web server
- `make start-admin` - Start admin frontend
- `make test` - Run tests
- `make test-bdd` - Run BDD tests
## Documentation
See the `docs/` directory for detailed documentation on various aspects of the project.