artifacts-dashboard/docs/AUTOMATION.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

1.2 KiB

Automation Guide

Strategies

Combat

Automated monster fighting with healing and loot management.

Config:

  • monster_code — target monster
  • auto_heal_threshold — HP% to trigger healing (default: 50)
  • heal_methodrest or consumable
  • consumable_code — item to use for healing
  • min_inventory_slots — minimum free slots before depositing (default: 3)
  • deposit_loot — auto-deposit at bank (default: true)

Gathering

Automated resource collection.

Config:

  • resource_code — target resource
  • deposit_on_full — deposit when inventory full (default: true)
  • max_loops — stop after N loops (0 = infinite)

Crafting

Automated crafting with optional material gathering.

Config:

  • item_code — item to craft
  • quantity — how many to craft
  • gather_materials — auto-gather missing materials
  • recycle_excess — recycle excess items

Trading

Grand Exchange automation.

Config:

  • modesell or buy
  • item_code — item to trade
  • min_price / max_price — price range
  • quantity — trade quantity

Task

NPC task automation.

Config:

  • Auto-accept, complete requirements, deliver, exchange coins.

Leveling

Composite strategy for optimal XP gain.