5dca8ecc79
- Introduced a new "Getting Started" guide to help users set up and use the YAZE software effectively. - Added detailed "Testing Guide" outlining the testing framework and best practices for contributors. - Created "Build Instructions" for macOS, Linux, and Windows, including environment verification and quick start with CMake presets. - Documented the architecture and networking aspects of YAZE, focusing on service-oriented design and gRPC integration. - Updated the index to reflect new documentation structure and improve navigation.
1.8 KiB
1.8 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.
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
Last updated: October 2025 - Version 0.3.2