2b11338e20
- Bump project version to 0.3.2 in CMakeLists.txt, vcpkg.json, and relevant headers. - Increase Windows stack size to 8MB to prevent stack overflow during asset loading. - Isolate development utilities from CI builds to ensure cleaner release artifacts. - Implement comprehensive bounds checking and fix segmentation faults in the graphics system. - Update documentation to reflect new build instructions and stability improvements.
47 lines
2.1 KiB
Markdown
47 lines
2.1 KiB
Markdown
# YAZE Documentation
|
|
|
|
Yet Another Zelda3 Editor - A comprehensive ROM editor for The Legend of Zelda: A Link to the Past.
|
|
|
|
## Quick Start
|
|
|
|
- [Getting Started](01-getting-started.md) - Basic setup and usage
|
|
- [Build Instructions](02-build-instructions.md) - Cross-platform build guide
|
|
- [Asar Integration](03-asar-integration.md) - 65816 assembler usage
|
|
- [API Reference](04-api-reference.md) - C/C++ API documentation
|
|
|
|
## Development
|
|
|
|
- [Testing Guide](A1-testing-guide.md) - Testing framework and best practices
|
|
- [Contributing](B1-contributing.md) - Development guidelines and standards
|
|
- [Platform Compatibility](B2-platform-compatibility.md) - Cross-platform support details
|
|
- [Build Presets](B3-build-presets.md) - CMake preset usage guide
|
|
- [Release Workflows](B4-release-workflows.md) - GitHub Actions release pipeline documentation
|
|
- [Stability Improvements](B5-stability-improvements.md) - Performance optimizations and reliability enhancements
|
|
|
|
## Technical Documentation
|
|
|
|
### Assembly & Code
|
|
- [Assembly Style Guide](E1-asm-style-guide.md) - 65816 assembly coding standards
|
|
|
|
### Editor Systems
|
|
- [Dungeon Editor Guide](E2-dungeon-editor-guide.md) - Complete dungeon editing guide
|
|
- [Dungeon Editor Design](E3-dungeon-editor-design.md) - Architecture and development guide
|
|
- [Dungeon Editor Refactoring](E4-dungeon-editor-refactoring.md) - Component-based architecture plan
|
|
- [Dungeon Object System](E5-dungeon-object-system.md) - Object management framework
|
|
|
|
### Overworld System
|
|
- [Overworld Loading](F1-overworld-loading.md) - 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* |