feat: Update z3ed README to enhance CLI output and help system documentation
This commit is contained in:
scawful
@@ -1,62 +1,62 @@
|
|||||||
# Roadmap
|
# Roadmap
|
||||||
|
|
||||||
## 0.4.X (Next Major Release)
|
**Last Updated: October 4, 2025**
|
||||||
|
|
||||||
### Core Features
|
This document outlines the development roadmap for YAZE. The project has made significant strides in core features, AI integration, and testing infrastructure. The immediate focus is on stabilizing the test suite and completing key editor functionalities.
|
||||||
- **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
|
|
||||||
- **Graphics Sheets**: Complete editing, saving, and re-importing of sheets
|
|
||||||
- **Project Refactoring**: Clean up resource loading and memory usage
|
|
||||||
|
|
||||||
### Technical Improvements
|
## Current Focus: Stability & Core Features
|
||||||
- **Sprite Property Editor**: Add support for changing sprite behavior and attributes
|
|
||||||
- **Custom Sprites**: Support creating and editing custom sprites
|
|
||||||
- **Asar Patching**: Stabilize existing patching system for advanced modifications
|
|
||||||
|
|
||||||
## 0.5.X
|
The highest priority is to fix the broken test suites to ensure the stability and correctness of the existing, largely complete, feature set. Alongside this, work will continue on completing the core AI and editor functionalities.
|
||||||
|
|
||||||
### Advanced Features
|
---
|
||||||
- **SCAD Format**: Polish and finalize the scad file integration
|
|
||||||
- **Hex Editing Improvements**: Enhance user interface for direct ROM manipulation
|
|
||||||
- **Music Editing**: Add an interface to edit and manage music data
|
|
||||||
|
|
||||||
## 0.6.X
|
## 0.4.X (Next Major Release) - Stability & Core Tooling
|
||||||
|
|
||||||
### Platform & Integration
|
### Priority 1: Testing & Stability (BLOCKER)
|
||||||
- **Cross-Platform Stability**: Test and refine builds across Windows, macOS, iOS, and Linux
|
- **Fix Dungeon Editor Test Suite**: Resolve the critical `SIGBUS` and `SIGSEGV` crashes that are blocking all integration tests for the dungeon system.
|
||||||
- **Plugin/Integration Framework**: Provide hooks or scripting for community add-ons
|
- **Refactor Integration Tests**: Migrate tests from the unstable `MockRom` to use the `TestRomManager` with real ROM files, following the pattern set by the passing rendering tests.
|
||||||
|
- **Expand E2E Coverage**: Create a comprehensive end-to-end smoke test for the Dungeon Editor and expand coverage for the Overworld editor.
|
||||||
|
|
||||||
## 0.7.X
|
### Priority 2: `z3ed` AI Agent
|
||||||
|
- **Complete Live LLM Testing**: Verify and harden the function-calling loop with live Ollama and Gemini models.
|
||||||
|
- **Enhance GUI Chat Widget**: Implement state persistence and integrate proposal review shortcuts directly into the editor's chat window.
|
||||||
|
- **Expand Agent Toolset**: Add new read-only tools for inspecting dialogue, sprite properties, and other game resources.
|
||||||
|
|
||||||
### Performance & Polish
|
### Priority 3: Editor Features
|
||||||
- **Performance Optimizations**: Remove bottlenecks in rendering and data processing
|
- **Dungeon Editor**: Implement missing features identified from the ZScream comparison, such as custom collision and object limits tracking.
|
||||||
- **Documentation Overhaul**: Update manuals, guides, and in-app tooltips
|
- **Overworld Sprites**: Complete the sprite editing workflow, including adding, removing, and moving sprites on the canvas.
|
||||||
|
- **Sprite Property Editor**: Create a UI to edit sprite attributes and behavior.
|
||||||
|
|
||||||
## 0.8.X
|
---
|
||||||
|
|
||||||
### Beta Preparation
|
## 0.5.X - Feature Expansion
|
||||||
- **Beta Release**: Code freeze on major features, focus on bug fixes and polish
|
|
||||||
- **User Interface Refinements**: Improve UI consistency, iconography, and layout
|
|
||||||
- **Internal Cleanup**: Remove deprecated code, finalize API calls
|
|
||||||
|
|
||||||
## 1.0.0
|
- **Plugin Architecture**: Design and implement the initial framework for community-developed extensions and custom tools.
|
||||||
|
- **Advanced Graphics Editing**:
|
||||||
|
- Finalize the Tile16 Editor palette system, fixing all known color consistency bugs.
|
||||||
|
- Implement functionality to edit and re-import full graphics sheets.
|
||||||
|
- **`z3ed` AI Agent Enhancements**:
|
||||||
|
- **Collaborative Sessions**: Investigate and implement infrastructure for multi-user collaborative editing and AI interaction.
|
||||||
|
- **Multi-modal Input**: Integrate screenshot capabilities to send visual context to Gemini for more accurate, context-aware commands.
|
||||||
|
|
||||||
### Stable Release
|
---
|
||||||
- **Stable Release**: Final, production-ready version
|
|
||||||
- **Changelog**: Comprehensive summary of all changes since 0.0.0
|
|
||||||
|
|
||||||
## Current Focus Areas
|
## 0.6.X - Polish & Integration
|
||||||
|
|
||||||
### Immediate Priorities (v0.4.X)
|
- **Cross-Platform Stability**: Conduct full testing and bug fixing cycles for Windows and Linux to ensure a stable experience equivalent to macOS.
|
||||||
1. **Dungeon Editor Refactoring**: Complete component-based architecture
|
- **Advanced Content Editors**:
|
||||||
2. **Sprite System**: Implement comprehensive sprite editing
|
- Implement a user interface for the music editing system.
|
||||||
3. **Graphics Pipeline**: Enhance graphics editing capabilities
|
- Enhance the Hex Editor with better search and data interpretation features.
|
||||||
4. **Plugin System**: Enable community extensions
|
- **Documentation Overhaul**:
|
||||||
|
- Implement a system to auto-generate C++ API documentation.
|
||||||
|
- Write a comprehensive user guide for ROM hackers, covering all major editor workflows.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 0.7.X and Beyond - Path to 1.0
|
||||||
|
|
||||||
|
- **Performance Optimization**: Implement high-priority items from the graphics performance plan, such as lazy loading of graphics and streaming assets from the ROM.
|
||||||
|
- **UI/UX Refinements**: Improve UI consistency, iconography, and overall layout based on user feedback.
|
||||||
|
- **Beta Release**: Code freeze on major features to focus on bug fixing and final polish.
|
||||||
|
- **1.0 Stable Release**: Final, production-ready version with a comprehensive changelog.
|
||||||
|
|
||||||
### Long-term Vision
|
|
||||||
- **Community-Driven**: Robust plugin system for community contributions
|
|
||||||
- **Cross-Platform Excellence**: Seamless experience across all platforms
|
|
||||||
- **Performance**: Optimized for large ROMs and complex modifications
|
|
||||||
- **Accessibility**: User-friendly interface for both beginners and experts
|
|
||||||
|
|||||||
@@ -162,7 +162,45 @@ Z3ED supports multiple AI providers. Configuration is resolved with command-line
|
|||||||
- `--gemini_api_key=<key>`: Your Gemini API key.
|
- `--gemini_api_key=<key>`: Your Gemini API key.
|
||||||
- `--ollama_host=<url>`: The URL for your Ollama server (default: `http://localhost:11434`).
|
- `--ollama_host=<url>`: The URL for your Ollama server (default: `http://localhost:11434`).
|
||||||
|
|
||||||
## 8. Roadmap & Implementation Status
|
## 8. CLI Output & Help System
|
||||||
|
|
||||||
|
The `z3ed` CLI features a modernized output system designed to be clean for users and informative for developers.
|
||||||
|
|
||||||
|
### Verbose Logging
|
||||||
|
|
||||||
|
By default, `z3ed` provides clean, user-facing output. For detailed debugging, including API calls and internal state, use the `--verbose` flag.
|
||||||
|
|
||||||
|
**Default (Clean):**
|
||||||
|
```bash
|
||||||
|
🤖 AI Provider: gemini
|
||||||
|
Model: gemini-2.5-flash
|
||||||
|
⠋ Thinking...
|
||||||
|
🔧 Calling tool: resource-list (type=room)
|
||||||
|
✓ Tool executed successfully
|
||||||
|
```
|
||||||
|
|
||||||
|
**Verbose Mode:**
|
||||||
|
```bash
|
||||||
|
# z3ed agent simple-chat "What is room 5?" --verbose
|
||||||
|
🤖 AI Provider: gemini
|
||||||
|
Model: gemini-2.5-flash
|
||||||
|
[DEBUG] Initializing Gemini service...
|
||||||
|
[DEBUG] Function calling: disabled
|
||||||
|
[DEBUG] Using curl for HTTPS request...
|
||||||
|
⠋ Thinking...
|
||||||
|
[DEBUG] Parsing response...
|
||||||
|
🔧 Calling tool: resource-list (type=room)
|
||||||
|
✓ Tool executed successfully
|
||||||
|
```
|
||||||
|
|
||||||
|
### Hierarchical Help System
|
||||||
|
|
||||||
|
The help system is organized by category for easy navigation.
|
||||||
|
|
||||||
|
- **Main Help**: `z3ed --help` or `z3ed -h` shows a high-level overview of command categories.
|
||||||
|
- **Category Help**: `z3ed help <category>` provides detailed information for a specific group of commands (e.g., `agent`, `patch`, `rom`).
|
||||||
|
|
||||||
|
## 9. Roadmap & Implementation Status
|
||||||
|
|
||||||
**Last Updated**: October 4, 2025
|
**Last Updated**: October 4, 2025
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user