Files
basegame-vcko/docs/README.md

542 B

VCK Online Docs

This folder contains developer documentation for the VCK Online dev/test server and game engine.

Start here

  • README_SERVER.md: how to run the FastAPI server and use the dev HTML client
  • dev-setup.md: local environment setup (venv + MariaDB connector)
  • database.md: database expectations, SSH tunnel, and stored procedure setup
  • server.md: FastAPI server architecture and API surface
  • game.md: game engine model and the DB-backed game bootstrap flow
  • testing.md: how to run the included test scripts