artifacts-dashboard/README.md
Paweł Orzech f845647934
Some checks failed
Release / release (push) Has been cancelled
Initial release: Artifacts MMO Dashboard & Automation Platform
Full-stack dashboard for controlling, automating, and analyzing
Artifacts MMO characters via the game's HTTP API.

Backend (FastAPI):
- Async Artifacts API client with rate limiting and retry
- 6 automation strategies (combat, gathering, crafting, trading, task, leveling)
- Automation engine with runner, manager, cooldown tracker, pathfinder
- WebSocket relay (game server -> frontend)
- Game data cache, character snapshots, price history, analytics
- 9 API routers, 7 database tables, 3 Alembic migrations
- 108 unit tests

Frontend (Next.js 15 + shadcn/ui):
- Live character dashboard with HP/XP bars and cooldowns
- Character detail with stats, equipment, inventory, skills, manual actions
- Automation management with live log streaming
- Interactive canvas map with content-type coloring and zoom/pan
- Bank management, Grand Exchange with price charts
- Events, logs, analytics pages with Recharts
- WebSocket auto-reconnect with query cache invalidation
- Settings page, error boundaries, dark theme

Infrastructure:
- Docker Compose (dev + prod)
- GitHub Actions CI/CD
- Documentation (Architecture, Automation, Deployment, API)
2026-03-01 19:46:45 +01:00

3.9 KiB

Artifacts MMO Dashboard

Dashboard & automation platform for Artifacts MMO — control, automate, and analyze your characters through a beautiful web interface.

Python Next.js FastAPI PostgreSQL Docker License

Features

  • Live Character Dashboard — real-time view of all 5 characters with HP, stats, equipment, inventory, skills, and cooldowns
  • Automation Engine — combat, gathering, crafting, trading, and task automation with configurable strategies
  • Interactive Map — world map with character positions, monsters, resources, and event overlays
  • Bank Management — searchable bank inventory with item details and estimated values
  • Grand Exchange — market browsing, order management, and price history charts
  • Event Tracking — live game events with notifications
  • Analytics — XP gain, gold tracking, actions/hour, and level progression charts
  • Multi-Character Coordination — resource pipelines, boss fights, and task distribution
  • WebSocket Updates — real-time dashboard updates via game WebSocket relay

Tech Stack

Layer Technology
Frontend Next.js 15, React 19, TypeScript, Tailwind CSS 4, shadcn/ui, TanStack Query, Recharts
Backend Python 3.12, FastAPI, SQLAlchemy (async), httpx, Pydantic v2
Database PostgreSQL 17
Deployment Docker Compose, Coolify

Quickstart

Prerequisites

Setup

  1. Clone the repository:

    git clone https://github.com/yourusername/artifacts-dashboard.git
    cd artifacts-dashboard
    
  2. Copy the environment file and add your API token:

    cp .env.example .env
    # Edit .env and set ARTIFACTS_TOKEN
    
  3. Start the stack:

    docker compose up
    
  4. Open your browser:

Project Structure

artifacts-dashboard/
├── backend/          # FastAPI application
│   ├── app/
│   │   ├── api/      # REST endpoints
│   │   ├── models/   # SQLAlchemy models
│   │   ├── schemas/  # Pydantic schemas
│   │   ├── services/ # Business logic
│   │   ├── engine/   # Automation engine
│   │   └── websocket/# WebSocket client & relay
│   └── tests/
├── frontend/         # Next.js application
│   └── src/
│       ├── app/      # Pages (App Router)
│       ├── components/
│       ├── hooks/
│       └── lib/
├── docs/             # Documentation
└── docker-compose.yml

Documentation

Contributing

Contributions are welcome! Please read the following before submitting:

  1. Fork the repository
  2. Create a feature branch: git checkout -b feature/my-feature
  3. Commit your changes: git commit -m "Add my feature"
  4. Push to the branch: git push origin feature/my-feature
  5. Open a Pull Request

Please use the provided issue and PR templates.

License

This project is licensed under the MIT License — see the LICENSE file for details.