ba50d89e7d
- Updated `.clang-tidy` and `.clangd` configurations for improved code quality checks and diagnostics. - Added new submodules for JSON and HTTP libraries to support future features. - Refined README and documentation files to standardize naming conventions and improve clarity. - Introduced a new command palette in the CLI for easier command access and execution. - Implemented various CLI handlers for managing ROM, sprites, palettes, and dungeon functionalities. - Enhanced the TUI components for better user interaction and command execution. - Added AI service integration for generating commands based on user prompts, expanding the CLI's capabilities.
2.1 KiB
2.1 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
- 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
- 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: December 2025 - Version 0.3.2