3200459c21
- Expanded the testing guide with detailed sections on widget registration, state introspection, and integration with AI agents for automated testing. - Added a new comprehensive readme for the z3ed agent, outlining its architecture, capabilities, and quick start instructions for AI-driven ROM hacking. - Updated the changelog to reflect recent enhancements in GUI and UX, including a theme system and modular architecture for the Overworld Editor. - Removed outdated networking documentation to streamline resources and improve clarity.
32 lines
1.5 KiB
Markdown
32 lines
1.5 KiB
Markdown
# yaze Documentation
|
|
|
|
Welcome to the official documentation for yaze, a comprehensive ROM editor for The Legend of Zelda: A Link to the Past.
|
|
|
|
## Core Guides
|
|
|
|
- [Getting Started](01-getting-started.md) - Basic setup and usage.
|
|
- [Build Instructions](02-build-instructions.md) - How to build yaze on Windows, macOS, and Linux.
|
|
- [z3ed CLI Guide](z3ed/README.md) - The AI-powered command-line interface.
|
|
|
|
## Development & API
|
|
|
|
- [Development Guide](development_guide.md) - Core architectural patterns, UI systems, and best practices.
|
|
- [GUI Testing Guide](gui_testing.md) - The end-to-end GUI testing framework.
|
|
- [API Reference](04-api-reference.md) - C/C++ API documentation for extensions.
|
|
- [Testing Guide](A1-testing-guide.md) - The testing framework and best practices.
|
|
- [Assembly Style Guide](E1-asm-style-guide.md) - 65816 assembly coding standards.
|
|
- [Build Presets](B3-build-presets.md) - A guide to the CMake preset system.
|
|
- [Release Workflows](B4-release-workflows.md) - GitHub Actions release pipeline documentation.
|
|
|
|
## Technical Documentation
|
|
|
|
- [Dungeon Editor Guide](D2-dungeon-editor-guide.md) - A master guide to the dungeon editing system.
|
|
- [Canvas Guide](G2-canvas-guide.md) - The core GUI drawing and interaction system.
|
|
- [Overworld Loading](F1-overworld-loading.md) - How vanilla and ZSCustomOverworld maps are loaded.
|
|
- [Platform Compatibility](B2-platform-compatibility.md) - Cross-platform support details.
|
|
- [Tile16 Editor Palette System](E7-tile16-editor-palette-system.md) - Design of the palette system.
|
|
|
|
---
|
|
|
|
*Last updated: October 2025 - Version 0.3.2*
|