e769cea1d9
- Added a new document, E5-debugging-guide.md, providing comprehensive strategies for debugging and testing the `yaze` application, including logging practices and testing frameworks. - Updated E2-development-guide.md to include a new section on debugging and testing, detailing quick debugging methods using command-line flags for specific editors and UI cards. - Enhanced the main application to support command-line flags for opening specific editors and cards on startup, improving the developer experience. - Refactored the Controller class to handle startup editor and card initialization based on command-line inputs.
2.2 KiB
2.2 KiB
yaze Documentation
Welcome to the official documentation for yaze, a comprehensive ROM editor for The Legend of Zelda: A Link to the Past.
A: Getting Started & Testing
- A1: Getting Started - Basic setup and usage.
- A2: Testing Guide - The testing framework and best practices.
B: Build & Platform
- B1: Build Instructions - How to build yaze on Windows, macOS, and Linux.
- B2: Platform Compatibility - Cross-platform support details.
- B3: Build Presets - A guide to the CMake preset system.
- B4: Release Workflows - GitHub Actions release pipeline documentation.
- B5: Architecture and Networking - System architecture, gRPC, and networking.
C: z3ed CLI
- C1:
z3edAgent Guide - The AI-powered command-line interface.
E: Development & API
- E1: Assembly Style Guide - 65816 assembly coding standards.
- E2: Development Guide - Core architectural patterns, UI systems, and best practices.
- E3: API Reference - C/C++ API documentation for extensions.
- E4: Emulator Development Guide
- E5: Debugging and Testing Guide - A master guide to the SNES emulator subsystem.
F: Technical Documentation
- F1: Dungeon Editor Guide - A master guide to the dungeon editing system.
- F2: Tile16 Editor Palette System - Design of the palette system.
- F3: Overworld Loading - How vanilla and ZSCustomOverworld maps are loaded.
G: GUI Guides
- G1: Canvas System and Automation - The core GUI drawing and interaction system.
H: Project Info
I: Roadmap
R: ROM Reference
- R1: A Link to the Past ROM Reference - Technical reference for ALTTP ROM structures, graphics, palettes, and compression.
Last updated: October 2025 - Version 0.3.3 (In Flux)