Skip to content

Building from Source

inksong edited this page Nov 8, 2026 · 1 revision

Building from Source

Requirements: Python 3.12 and Node 22.12 or later.

git clone https://github.com/ANetResearch/ANet-Relay.git && cd ANet-Relay
python3.12 -m venv .venv && .venv/bin/pip install -e "./backend[dev]"
npm ci && npm ci --prefix web
npm run dev                 # Vite, Electron and the backend with one operator token
npm test                    # backend pytest, web unit tests and build, end-to-end suite
npm run dist:mac            # or dist:linux; packages land in release/

The backend runs on its own with .venv/bin/python -m relay --dev, which prints an operator token.

Repository layout

Path Contents
electron/ Desktop shell: window, app://relay protocol, menus, backend supervisor, Copilot (electron/copilot/)
backend/relay/ MAVLink links and drivers, control authority, sessions and skills, simulator (sim/), program host and judge, LAN arena (peers/), scenarios, history, REST and WebSocket API
web/ Interface: React, three.js stage, Graphite theme, English and Chinese
sdk/python/, mcp/ Python SDK with examples; three MCP servers
tools/fakes/ Fake bridge and flight controller for testing without hardware
e2e/ Playwright tests against the real backend
docs/ Guides; docs/design/ holds the binding design of each version (Chinese)

Releases

Pushing a v* tag builds macOS (arm64 and x64, signed and notarized), Linux and Windows packages on GitHub Actions and publishes them with the matching section of the changelog.

Contributing

Issues and pull requests are welcome in English or Chinese. Changes to the control model, the agent API or the stop semantics must begin with an issue. npm test is the merge gate.

Clone this wiki locally