scawful/yaze
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README and documentation for v0.3.0 release

Browse Source 
- Revamped README.md to provide a clearer overview of the project, including updated platform support, key features, and installation instructions.
- Added a new asar-integration.md file detailing the Asar 65816 assembler integration, including usage examples and API references.
- Updated changelog.md to reflect new features and improvements in version 0.3.0, including Asar integration, ZSCustomOverworld v3, and enhanced message editing.
- Revised getting-started.md to indicate the completion of Asar patching features and updated CLI command statuses.
- Enhanced index.md to include new documentation links and a summary of major new features in the latest release.
- Improved infrastructure.md to reflect the transition to C++23 and modern CMake practices.
This commit is contained in:
scawful
2025-09-25 09:28:46 -04:00
parent 6bdcfe95ec
commit a1429a8199
7 changed files with 593 additions and 121 deletions
Download Patch File Download Diff File Expand all files Collapse all files

152
docs/index.md
View File

@@ -1,115 +1,145 @@
# Yaze Documentation
Welcome to the Yaze documentation. This cross-platform Zelda 3 ROM editor is built with C++20, SDL2, and ImGui, designed to be compatible with ZScream projects.
Welcome to the Yaze documentation. This cross-platform Zelda 3 ROM editor is built with modern C++23, SDL2, ImGui, and integrated Asar 65816 assembler support.
## Quick Start
- [Getting Started](getting-started.md) - Basic setup and usage
- [Build Instructions](build-instructions.md) - How to build yaze
- [Build Instructions](build-instructions.md) - How to build yaze from source
- [Contributing](contributing.md) - How to contribute to the project
## New in v0.3.0
- [Asar Integration Guide](asar-integration.md) - Complete 65816 assembler integration
- [Roadmap](roadmap.md) - Updated development plans and release timeline
- [Changelog](changelog.md) - Complete version history and changes
## Core Documentation
### Architecture & Infrastructure
- [Infrastructure](infrastructure.md) - Project structure and architecture
- [Infrastructure](infrastructure.md) - Project structure and modern build system
- [Assembly Style Guide](asm-style-guide.md) - 65816 assembly coding standards
### Editors
#### Dungeon Editor
#### Overworld Editor
- [Overworld Loading Guide](overworld_loading_guide.md) - ZSCustomOverworld v3 implementation
- [Overworld Expansion](overworld-expansion.md) - Advanced overworld features
#### Dungeon Editor
- [Dungeon Editor Guide](dungeon-editor-comprehensive-guide.md) - Complete dungeon editing guide
- [Dungeon Editor Design Plan](dungeon-editor-design-plan.md) - Architecture and development guide
- [Dungeon Integration Tests](dungeon-integration-tests.md) - Testing framework
#### Overworld Editor
- [Overworld Loading Guide](overworld_loading_guide.md) - ZScream vs Yaze implementation
- [Overworld Expansion](overworld-expansion.md) - ZSCustomOverworld features
### Graphics & UI
- [Canvas Interface Refactoring](canvas-refactor-summary.md) - Canvas system architecture
- [Canvas Migration](canvas-migration.md) - Migration guide for canvas changes
### Testing
### Testing & Development
- [Integration Test Guide](integration_test_guide.md) - Comprehensive testing framework
## Project Status
## Current Version: 0.3.0 (January 2025)
### Current Version: 0.2.2 (12-31-2024)
### ✅ Major New Features
#### ✅ Completed Features
- **Dungeon Editor**: Full dungeon editing with object rendering, sprite management, and room editing
- **Overworld Editor**: Complete overworld editing with ZSCustomOverworld v2/v3 support
- **Canvas System**: Refactored pure function interface with backward compatibility
- **Graphics System**: Optimized rendering with caching and performance monitoring
- **Integration Tests**: Comprehensive test suite for all major components
#### Asar 65816 Assembler Integration
- **Cross-platform ROM patching** with assembly code support
- **Symbol extraction** with addresses and opcodes
- **Assembly validation** and comprehensive error reporting
- **Modern C++ API** with safe memory management
- **Enhanced CLI tools** with improved UX
#### 🔄 In Progress
- **Sprite Builder System**: Custom sprite creation and editing
#### ZSCustomOverworld v3
- **Enhanced overworld editing** capabilities
- **Advanced map properties** and metadata
- **Custom graphics support** and tile management
- **Improved compatibility** with existing projects
#### Advanced Message Editing
- **Enhanced text editing interface** with improved parsing
- **Real-time preview** of message formatting
- **Better error handling** for message validation
- **Improved workflow** for text-based ROM hacking
#### GUI Docking System
- **Improved workspace management** with flexible layouts
- **Better window organization** for complex editing tasks
- **Enhanced user workflow** with customizable interfaces
- **Modern UI improvements** throughout the application
#### Technical Improvements
- **Modern CMake 3.16+**: Target-based configuration and build system
- **CMakePresets**: Development workflow presets for better productivity
- **Cross-platform CI/CD**: Automated builds and testing for all platforms
- **Professional packaging**: NSIS, DMG, and DEB/RPM installers
- **Enhanced testing**: ROM-dependent test separation for CI compatibility
### 🔄 In Progress
- **Sprite Builder System**: Custom sprite creation and editing tools
- **Emulator Subsystem**: SNES emulation for testing modifications
- **Music Editor**: Music data editing interface
- **Music Editor**: Enhanced music data editing interface
#### ⏳ Planned
- **Advanced Object Editing**: Multi-object selection and manipulation
- **Plugin System**: Modular architecture for community extensions
- **Performance Optimizations**: Further rendering and memory optimizations
### ⏳ Planned for 0.4.X
- **Overworld Sprites**: Complete sprite editing with add/remove functionality
- **Enhanced Dungeon Editing**: Advanced room object editing and manipulation
- **Tile16 Editing**: Enhanced editor for creating and modifying tile16 data
- **Plugin Architecture**: Framework for community extensions and custom tools
## Key Features
### Dungeon Editing
- Room object editing with real-time rendering
- Sprite management (enemies, NPCs, interactive objects)
- Item placement (keys, hearts, rupees, etc.)
- Entrance/exit management and room connections
- Door management with key requirements
- Chest management with treasure placement
- Undo/redo system with comprehensive state management
### ROM Editing Capabilities
- **Asar 65816 Assembly**: Apply assembly patches with symbol extraction
- **Overworld Editing**: ZSCustomOverworld v3 with enhanced features
- **Message Editing**: Advanced text editing with real-time preview
- **Palette Management**: Comprehensive color and palette editing
- **Graphics Editing**: SNES graphics manipulation and preview
- **Hex Editing**: Direct ROM data editing with validation
### Overworld Editing
- ZSCustomOverworld v2/v3 compatibility
- Custom background colors and overlays
- Map properties and metadata editing
- Sprite positioning and management
- Tile16 editing and graphics management
### Development Tools
- **Enhanced CLI**: Modern z3ed with subcommands and interactive TUI
- **Symbol Analysis**: Extract and analyze assembly symbols
- **ROM Validation**: Comprehensive ROM integrity checking
- **Project Management**: Save and load complete ROM hacking projects
### Graphics System
- High-performance object rendering with caching
- SNES palette support and color management
- Graphics sheet editing and management
- Real-time preview and coordinate system management
### Cross-Platform Support
- **Windows**: Full support with MSVC and MinGW compilers
- **macOS**: Universal binaries supporting Intel and Apple Silicon
- **Linux**: GCC and Clang support with package management
- **Professional Packaging**: Native installers for all platforms
## Compatibility
### ROM Support
- **Vanilla ROMs**: Original Zelda 3 ROMs (US/JP)
- **ZSCustomOverworld v2**: Enhanced overworld features
- **ZSCustomOverworld v3**: Advanced features with overlays and custom graphics
- **ZSCustomOverworld v2/v3**: Enhanced overworld features and compatibility
- **Custom Modifications**: Support for community ROM hacks and modifications
### Platform Support
- **Windows**: Full support with native builds
- **macOS**: Full support with native builds
- **Linux**: Full support with native builds
- **iOS**: Basic support (work in progress)
### File Format Support
- **Assembly Files**: .asm files with Asar 65816 assembler
- **BPS Patches**: Standard ROM patching format
- **Graphics Files**: PNG, BMP, and SNES-specific formats
- **Project Files**: .yaze project format for complete editing sessions
## Development
## Development & Community
### Architecture
- **Modern C++23**: Latest language features for performance and safety
- **Modular Design**: Component-based architecture for maintainability
- **Cross-Platform**: SDL2 and ImGui for consistent UI across platforms
- **Modern C++**: C++20 features for performance and safety
- **Testing**: Comprehensive integration test suite
- **Cross-Platform**: Consistent experience across all supported platforms
- **Comprehensive Testing**: Unit tests, integration tests, and ROM validation
### Contributing
See [Contributing](contributing.md) for guidelines on:
- Code style and standards
- Testing requirements
- Pull request process
- Development setup
## Community
- Code style and C++23 standards
- Testing requirements and ROM handling
- Pull request process and review
- Development setup with CMake presets
### Community
- **Discord**: [Oracle of Secrets Discord](https://discord.gg/MBFkMTPEmk)
- **GitHub**: [Yaze Repository](https://github.com/scawful/yaze)
- **Issues**: Report bugs and request features on GitHub
- **Discussions**: Community discussions and support
## License
@@ -117,4 +147,4 @@ This project is licensed under the terms specified in the [LICENSE](../LICENSE)
---
*Last updated: December 2024*
*Last updated: January 2025 - Version 0.3.0*