2ac363918e
- Deleted the ImGui Widget Testing Guide as it is no longer needed. - Updated the main documentation index to reflect the new Dungeon Editor Guide location. - Revised z3ed README to clarify core capabilities and quick start instructions. - Removed the developer guide for z3ed as its content is now integrated into other documentation. - Enhanced the architecture section to provide a clearer overview of the z3ed system components. - Updated command references and added details on agent commands and workflows.
1.7 KiB
1.7 KiB
yaze Documentation
Yet Another Zelda3 Editor - A comprehensive ROM editor for The Legend of Zelda: A Link to the Past.
Quick Start
- Getting Started - Basic setup and usage
- Build Instructions - Cross-platform build guide
- Asar Integration - 65816 assembler usage
- API Reference - C/C++ API documentation
Development
- Testing Guide - Testing framework and best practices
- Platform Compatibility - Cross-platform support details
- Build Presets - CMake preset usage guide
- Release Workflows - GitHub Actions release pipeline documentation
- Stability Improvements - Performance optimizations and reliability enhancements
Technical Documentation
Assembly & Code
- Assembly Style Guide - 65816 assembly coding standards
Editor Systems
- Dungeon Editor Guide - Complete dungeon editing guide
Overworld System
- Overworld Loading - ZSCustomOverworld v3 implementation
Key Features
- Complete GUI editor for all aspects of Zelda 3 ROM hacking
- Integrated Asar 65816 assembler for custom code patches
- ZSCustomOverworld v3 support for enhanced overworld editing
- Cross-platform support (Windows, macOS, Linux)
- Modern C++23 codebase with comprehensive testing
- Windows Development: Automated setup scripts, Visual Studio integration, vcpkg package management
- CMake Compatibility: Automatic handling of submodule compatibility issues (abseil-cpp, SDL)