Re-BattleTanx

A browser fan port inspired by BattleTanx (N64). The game lives in re-tanx/; everything else here is history.

Path	What it is
re-tanx/	The game: npm workspace with sim, client and server packages, data, docs, Docker setup. Start there.
re-tanx/docs/	Design docs, engineering docs, plans and guides (map authoring, self-hosting).
OLD/	Earlier drafts: the first design-doc set (battletanx-docs/) and scaffold archives. Superseded by re-tanx/docs/; kept for reference.
re-tanx.zip	A snapshot archive of the project. The checked-in re-tanx/ tree is the source of truth.

Quick start

cd re-tanx
npm install
npm run dev        # client at http://localhost:5173
npm run server     # game server for online play, :8787
npm run check      # rules + IP guard + typecheck + tests

Update the hosted instance

On the Docker Compose host, from the repository root:

bash update.sh

The script fetches the current branch's upstream, fast-forwards, builds the update, restarts game and web, and checks the website and game health. It keeps the database volume and local .env; builds finish before the running application is restarted. Active matches disconnect during the restart.

Changes must be committed and pushed to GitHub first. On the first run, use git pull --ff-only to obtain the script. Details and recovery: self-hosting guide.

Fan project, non-commercial, no ripped assets. See the legal note in re-tanx/docs/README.md.