Skip to content
N3oTraXPublic

About

Complete Hytale Server Management Platform with Discord Integration

Resources

Contributing

Stars

1 star

Watchers

0 watching

Forks

Repository files navigation

BotTale

🎮 Complete Hytale Server Management Platform with Discord Integration

Warning

Ce projet est en cours de développement et n'est pas prêt pour la production.

Les fonctionnalités peuvent être incomplètes, instables ou sujettes à des changements majeurs sans préavis. Le repository représente donc un State of the Art de l'état d'avancement du projet. Lorsqu'il fera l'objet d'une première release je considérerai qu'il bascule définitivement de statut. Pour le moment, libre à vous de tester et/ou de m'aider, ou vous en servir de base pour votre propre projet du moment que vous y autorise.

License: GPL-3.0 Docker TypeScript Node.js Discord


Overview

BotTale is an all-in-one platform for managing Hytale game servers. It provides:

  • Web Dashboard: Modern React interface for server management
  • Discord Bot: Full server control through Discord commands
  • External Server Support: Manage standalone Hytale servers via SSH
  • Deployment Profiles: One-click server deployment with templates

Features

🔐 Authentication & Security

  • Discord OAuth2 authentication
  • Role-based access control
  • Secure session management with JWT
  • Encrypted credential storage (AES-256)

🎮 Server Management

  • Create and configure Hytale servers
  • Real-time console access (WebSocket)
  • Start, stop, restart servers remotely
  • CPU/RAM monitoring and metrics
  • Automated backups

🤖 Discord Bot

  • Slash commands for server control
  • Player whitelist management
  • Server status notifications
  • Interactive buttons and menus

🌐 External Server Support

  • Connect standalone Hytale servers via SSH
  • Full control through web interface
  • Systemd service integration
  • Log streaming and command execution

📊 Monitoring & Analytics

  • Real-time server metrics
  • Player tracking
  • Audit logs
  • Alert system

Quick Start

Prerequisites

  • Docker & Docker Compose
  • Discord Application (Create one)
  • Domain with SSL (recommended for production)

Installation

# Clone the repository
git clone https://github.com/N3oTraX/bottale.git
cd bottale

# Configure environment
cp .env.example .env
# Edit .env with your Discord credentials and secrets

# Start services
docker-compose up -d

# Run database migrations
docker-compose run --rm migrate

📚 Complete Installation Guide →


Documentation

Section Description
📥 Installation Complete installation guide
🔀 Traefik Setup Reverse proxy with automatic HTTPS
⚙️ Configuration Environment variables and options
🏗️ Architecture Technical architecture overview
🛠️ Development Contributor guide
🔌 API Reference tRPC endpoints documentation
🎮 External Servers Deploy standalone Hytale servers

Project Structure

bottale/
├── apps/
│   ├── backend/              # Fastify API + tRPC
│   ├── frontend/             # React SPA (Vite)
│   ├── bot/                  # Discord bot (discord.js)
│   └── docs/                 # Documentation site
├── packages/
│   ├── api/                  # Shared tRPC contracts
│   ├── db/                   # Prisma schema & migrations
│   ├── types/                # Shared TypeScript types
│   └── ui/                   # Shared UI components
├── traefik-stack/            # Traefik reverse proxy stack
├── external-server-template/ # Standalone Hytale server template
├── docs/                     # Documentation
└── docker-compose.yml        # Production orchestration

Tech Stack

Layer Technology
Monorepo Turborepo + pnpm
Backend Fastify 5, tRPC 11, Prisma 5
Frontend React 19, Vite 5, TanStack Query
Bot discord.js 14, Node.js 22
Database PostgreSQL 16
Cache Redis 7
Proxy Traefik 3
Containers Docker, Docker Compose

Development

# Install dependencies
pnpm install

# Start development servers
pnpm dev

# Run tests
pnpm test

# Lint and format
pnpm lint
pnpm format

Using Make

make build     # Build Docker images
make up        # Start services
make down      # Stop services
make logs      # View logs
make migrate   # Run migrations
make test      # Run tests

External Server Template

BotTale supports managing standalone Hytale servers running on remote machines. The external-server-template/ directory contains everything needed to deploy a compatible server:

# On your game server
cd /opt
git clone https://github.com/N3oTraX/bottale.git
cp -r bottale/external-server-template /opt/hytale

# Follow the setup guide
cat /opt/hytale/README.md

📖 External Server Guide →


Contributing

We welcome contributions! Please see our Contributing Guide for details.

  1. Fork the repository
  2. Create a feature branch
  3. Make your changes
  4. Submit a pull request

License

This project is licensed under the GNU General Public License v3.0 - see the LICENSE file for details.


Support


Acknowledgments

  • Hytale - The game we're building this for
  • Discord.js - Discord bot framework
  • tRPC - End-to-end typesafe APIs
  • Prisma - Database ORM

About

Complete Hytale Server Management Platform with Discord Integration

Resources

Contributing

Stars

1 star

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages