- 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.
1.5 KiB
1.5 KiB
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 - Basic setup and usage.
- Build Instructions - How to build yaze on Windows, macOS, and Linux.
- z3ed CLI Guide - The AI-powered command-line interface.
Development & API
- Development Guide - Core architectural patterns, UI systems, and best practices.
- GUI Testing Guide - The end-to-end GUI testing framework.
- API Reference - C/C++ API documentation for extensions.
- Testing Guide - The testing framework and best practices.
- Assembly Style Guide - 65816 assembly coding standards.
- Build Presets - A guide to the CMake preset system.
- Release Workflows - GitHub Actions release pipeline documentation.
Technical Documentation
- Dungeon Editor Guide - A master guide to the dungeon editing system.
- Canvas Guide - The core GUI drawing and interaction system.
- Overworld Loading - How vanilla and ZSCustomOverworld maps are loaded.
- Platform Compatibility - Cross-platform support details.
- Tile16 Editor Palette System - Design of the palette system.
Last updated: October 2025 - Version 0.3.2