2.1 KiB
2.1 KiB
/** @mainpage YAZE Documentation @tableofcontents */
YAZE Documentation
Welcome to the YAZE documentation. This site covers installation, usage, and development of the YAZE ROM editor for The Legend of Zelda: A Link to the Past.
Quick Links
| Goal | Start Here |
|---|---|
| Get started | Getting Started |
| Build from source | Build Quick Reference |
| Understand the code | Architecture Overview |
| Fix build issues | Build Troubleshooting |
| Use the CLI | z3ed CLI Guide |
Documentation Sections
Getting Started
Build and Tooling
- Build Quick Reference - Essential build commands
- Build from Source - Full build guide
- CMake Presets - Preset reference
- Platform Compatibility - OS-specific notes
- Build Troubleshooting - Common issues
Usage Guides
- Dungeon Editor - Room editing guide
- z3ed CLI - Command-line interface
- Web App - Browser-based editor (preview)
- Overworld Loading - Technical reference
Developer Guides
- Architecture Overview - System design
- Testing Guide - Test organization and execution
- Debugging Guide - Debugging workflows
- Canvas System - UI canvas reference
- Palette System - Color handling
Reference
- ROM Reference - ROM data structures
- z3ed Command Reference - CLI commands
- Changelog - Version history
Internal Documentation: Development plans, agent workflows, and architecture deep-dives are in docs/internal/.