f59af42555
- Updated the vcpkgGitCommitId to '2024.12.12' in release-complex.yml, release-simplified.yml, and release.yml for consistency. - Added a new documentation file B4-release-workflows.md detailing the different release workflows, their purposes, features, and use cases. - Updated index.md to include a link to the new release workflows documentation.
2.0 KiB
2.0 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
- Contributing - Development guidelines and standards
- Platform Compatibility - Cross-platform support details
- Build Presets - CMake preset usage guide
- Release Workflows - GitHub Actions release pipeline documentation
Technical Documentation
Assembly & Code
- Assembly Style Guide - 65816 assembly coding standards
Editor Systems
- Dungeon Editor Guide - Complete dungeon editing guide
- Dungeon Editor Design - Architecture and development guide
- Dungeon Editor Refactoring - Component-based architecture plan
- Dungeon Object System - Object management framework
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)
Last updated: September 2025 - Version 0.3.0