feat: Implement ROM version management and proposal approval system
- Introduced `RomVersionManager` for managing ROM snapshots, including automatic backups, manual checkpoints, and corruption detection. - Added `ProposalApprovalManager` to facilitate collaborative proposal submissions and voting, enhancing team workflows. - Updated `CollaborationPanel` to integrate version management features, allowing users to track changes and manage proposals effectively. - Enhanced documentation to reflect new functionalities and usage instructions for version management and collaboration features.
This commit is contained in:
@@ -1,42 +1,29 @@
|
||||
# yaze Documentation
|
||||
|
||||
Yet Another Zelda3 Editor - A comprehensive ROM editor for The Legend of Zelda: A Link to the Past.
|
||||
Welcome to the official documentation for yaze, a comprehensive ROM editor for The Legend of Zelda: A Link to the Past.
|
||||
|
||||
## Quick Start
|
||||
## Core Guides
|
||||
|
||||
- [Getting Started](01-getting-started.md) - Basic setup and usage
|
||||
- [Build Instructions](02-build-instructions.md) - Cross-platform build guide
|
||||
- [API Reference](04-api-reference.md) - C/C++ API documentation
|
||||
- [Getting Started](01-getting-started.md) - Basic setup and usage.
|
||||
- [Build Instructions](02-build-instructions.md) - How to build yaze on Windows, macOS, and Linux.
|
||||
- [z3ed CLI Guide](z3ed/README.md) - The AI-powered command-line interface.
|
||||
|
||||
## Development
|
||||
## Development & API
|
||||
|
||||
- [Testing Guide](A1-testing-guide.md) - Testing framework and best practices
|
||||
- [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
|
||||
- [API Reference](04-api-reference.md) - C/C++ API documentation for extensions.
|
||||
- [Testing Guide](A1-testing-guide.md) - The testing framework and best practices.
|
||||
- [Assembly Style Guide](E1-asm-style-guide.md) - 65816 assembly coding standards.
|
||||
- [Build Presets](B3-build-presets.md) - A guide to the CMake preset system.
|
||||
- [Release Workflows](B4-release-workflows.md) - GitHub Actions release pipeline documentation.
|
||||
|
||||
## Technical Documentation
|
||||
|
||||
### Assembly & Code
|
||||
- [Assembly Style Guide](E1-asm-style-guide.md) - 65816 assembly coding standards
|
||||
|
||||
### Editor Systems
|
||||
- [Dungeon Editor Master Guide](dungeon_editor_master_guide.md) - Complete dungeon editing guide
|
||||
|
||||
### 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)
|
||||
- [Dungeon Editor Guide](D2-dungeon-editor-guide.md) - A master guide to the dungeon editing system.
|
||||
- [Canvas Guide](G2-canvas-guide.md) - The core GUI drawing and interaction system.
|
||||
- [Overworld Loading](F1-overworld-loading.md) - How vanilla and ZSCustomOverworld maps are loaded.
|
||||
- [Platform Compatibility](B2-platform-compatibility.md) - Cross-platform support details.
|
||||
- [Tile16 Editor Palette System](E7-tile16-editor-palette-system.md) - Design of the palette system.
|
||||
|
||||
---
|
||||
|
||||
*Last updated: December 2025 - Version 0.3.2*
|
||||
*Last updated: October 2025 - Version 0.3.2*
|
||||
|
||||
Reference in New Issue
Block a user