Documentation
Start with development setup to build, test, and run the application. The public roadmap tracks project work. There is no game runtime or editor yet; the first engine milestone's behavior and acceptance criteria remain to be agreed.
These guides are available as a searchable site. See documentation maintenance for the build, PR preview, and publication procedure.
Working on the application
| Task | Read |
|---|---|
| Install tools, run locally, or debug | Development setup |
| Choose a task or propose a change | Contributing and open issues |
| Understand the current HTTP surface and health checks | API |
| Run tests and understand their limits | Testing |
| Maintain agent instructions and vendored skills | AI tooling maintenance and AI policy |
| Check browser and accessibility expectations | Browser support |
| Host, deploy, or recover a release | Hosting, GitHub setup, and SSH host-key verification |
| Prepare a release or patch | Release process, changelog, and versioning |
| Ask a question or report privately | Support and security |
| Check responsibilities or bring in historical material | Practical stewardship |
Repository map
- API contracts contain browser-compatible DTOs. The API client depends on these contracts, not on the server host.
- The API host serves HTTP endpoints and uses service defaults for health checks, resilience, and telemetry.
- The web client is standalone Blazor WebAssembly and calls the typed API client.
- AppHost launches the API and frontend locally. Compose deployment is separate from local Aspire orchestration.
- Tests cover the API/client and deployment tooling. Engine code, when introduced, should remain testable without Blazor, HTTP, or storage.
Formatting and compiler rules live in .editorconfig and
Directory.Build.props; the contribution and testing
guides describe the current workflow. Database, blob-storage, and performance
design documents should accompany real features rather than empty placeholders.
MyGameBuilder history and source boundaries
The original material is separate from this implementation. Start with the archive pointer and format documentation pointer. Follow the AI/source-material policy for independent compatibility work. Forum preservation pointers and community contact information provide historical context; private chat is not required for contributing.
General learning resources
General framework and tooling references belong in the organization's shared learning resources. Keep application-specific instructions here and link to shared material rather than maintaining another reference library.