diff --git a/docs/changelog.md b/docs/changelog.md index 4720b9f0..94b1f30c 100644 --- a/docs/changelog.md +++ b/docs/changelog.md @@ -1,42 +1,35 @@ # Changelog ## 0.2.2 (12-31-2024) - - DungeonMap editing improvements - ZSCustomOverworld support - Cross platform file handling ## 0.2.1 (08-20-2024) - - Improved MessageEditor parsing - Added integration test window - Bitmap bug fixes ## 0.2.0 (07-20-2024) - - iOS app support - Graphics Sheet Browser - Project Files ## 0.1.0 (05-11-2024) - - Bitmap bug fixes - Error handling improvements ## 0.0.9 (04-14-2024) - - Documentation updates - Entrance tile types - Emulator subsystem overhaul ## 0.0.8 (02-08-2024) - - Hyrule Magic Compression - Dungeon Room Entrances - Png Export ## 0.0.7 (01-27-2024) - - OverworldEntities - Entrances - Exits @@ -44,25 +37,21 @@ - Sprites ## 0.0.6 (11-22-2023) - - ScreenEditor DungeonMap - Tile16 Editor - Canvas updates ## 0.0.5 (11-21-2023) - - DungeonEditor - DungeonObjectRenderer ## 0.0.4 (11-11-2023) - - Tile16Editor - GfxGroupEditor - Add GfxGroups fns to Rom - Add Tile16Editor and GfxGroupEditor to OverworldEditor ## 0.0.3 (10-26-2023) - - Emulator subsystem - Snes Ppu and PpuRegisters - Direct Memory Access @@ -73,7 +62,6 @@ ## 0.0.2 (08-26-2023) - - Emulator subsystem - Spc700 - Emulator loop @@ -87,7 +75,6 @@ - Overworld Map Tile Editing ## 0.0.1 (07-22-2023) - - GraphicsEditor - Palette management - lc_lz2 Compression diff --git a/docs/getting-started.md b/docs/getting-started.md index a7105228..34300b3c 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -1,6 +1,6 @@ # Getting Started -This software allows you to modify "The Legend of Zelda: A Link to the Past" (US or JP) ROMs. +This software allows you to modify "The Legend of Zelda: A Link to the Past" (US or JP) ROMs. This editor is built to be compatible with ZScream projects and is designed to be cross platform. @@ -17,44 +17,42 @@ In addition to the built-in features, this software provides a pure C library in This feature is still in development and is not yet fully documented. -## Supported Features +## Supported Features -| Feature | Status | Details | -|---------|--------|-------------| -| Overworld Maps | Done | Edit and save tile32 data. | -| Overworld Map Properties | Done | Edit and save map properties. | -| Overworld Entrances | Done | Edit and save entrance data. | -| Overworld Exits | Done | Edit and save exit data. | -| Overworld Sprites | In Progress | Edit sprite positions, add and remove sprites. | -| Tile16 Editing | Todo | Edit and save tile16 data. | -| Dungeon | In Progress | View dungeon room metadata and edit room data. | -| Palette | In Progress | Edit and save palettes, palette groups. | -| Graphics Sheets | In Progress | Edit and save graphics sheets. | -| Graphics Groups | Done | Edit and save graphics groups. | -| Sprite | Todo | View-only sprite data. | -| Custom Sprites | Todo | Edit and create custom sprite data. | -| Music | Todo | Edit music data. | -| Dungeon Maps | Todo | Edit dungeon maps. | -| Scad Format | Done-ish | Open and view scad files (SCR, CGX, COL) | -| Hex Editing | Done | View and edit ROM data in hex. | -| Asar Patching | In Progress | Apply Asar patches to your ROM or Project. | +| Feature | Status | Details | +|-------------------|-------------|------------------------------------------------| +| Overworld Maps | Done | Edit and save tile32 data. | +| OW Map Properties | Done | Edit and save map properties. | +| OW Entrances | Done | Edit and save entrance data. | +| OW Exits | Done | Edit and save exit data. | +| OW Sprites | In Progress | Edit sprite positions, add and remove sprites. | +| Tile16 Editing | Todo | Edit and save tile16 data. | +| Dungeon | In Progress | View dungeon room metadata and edit room data. | +| Palette | In Progress | Edit and save palettes, palette groups. | +| Graphics Sheets | In Progress | Edit and save graphics sheets. | +| Graphics Groups | Done | Edit and save graphics groups. | +| Sprite | Todo | View-only sprite data. | +| Custom Sprites | Todo | Edit and create custom sprite data. | +| Music | Todo | Edit music data. | +| Dungeon Maps | Todo | Edit dungeon maps. | +| Scad Format | Done-ish | Open and view scad files (SCR, CGX, COL) | +| Hex Editing | Done | View and edit ROM data in hex. | +| Asar Patching | In Progress | Apply Asar patches to your ROM or Project. | ## Command Line Interface Included with the editor is a command line interface (CLI) that allows you to perform various operations on your ROMs from the command line. This aims to reduce the need for multiple tools in zelda3 hacking like Zcompress, LunarExpand, LunarAddress, Asar, and others. -| Command | Arg | Params | Status | -|---------|-----|--------|--------| -| Apply BPS Patch | -a | rom_file bps_file | In progress | -| Create BPS Patch | -c | bps_file src_file modified_file | Not started | -| Asar Patch | -asar | asm_file rom_file | In progress | -| Open ROM | -o | rom_file | Complete | -| Backup ROM | -b | rom_file [new_file] | In progress | -| Expand ROM | -x | rom_file file_size | Not started | -| Transfer Tile16 | -t | src_rom dest_rom tile32_id_list(csv) | Complete | -| Export Graphics | -e | rom_file bin_file | In progress | -| Import Graphics | -i | bin_file rom_file | Not started | -| SNES to PC Address | -s | address | Complete | -| PC to SNES Address | -p | address | Complete | - - +| Command | Arg | Params | Status | +|--------------------|-------|--------------------------------------|-------------| +| Apply BPS Patch | -a | rom_file bps_file | In progress | +| Create BPS Patch | -c | bps_file src_file modified_file | Not started | +| Asar Patch | -asar | asm_file rom_file | In progress | +| Open ROM | -o | rom_file | Complete | +| Backup ROM | -b | rom_file [new_file] | In progress | +| Expand ROM | -x | rom_file file_size | Not started | +| Transfer Tile16 | -t | src_rom dest_rom tile32_id_list(csv) | Complete | +| Export Graphics | -e | rom_file bin_file | In progress | +| Import Graphics | -i | bin_file rom_file | Not started | +| SNES to PC Address | -s | address | Complete | +| PC to SNES Address | -p | address | Complete | diff --git a/docs/roadmap.md b/docs/roadmap.md new file mode 100644 index 00000000..de1e2ab0 --- /dev/null +++ b/docs/roadmap.md @@ -0,0 +1,44 @@ +# Roadmap + +## 0.2.X (Current) +- Overworld Editing Features +- Palette Editing Features +- Hex Editing + +## 0.3.X +- Overworld Sprites: Complete sprite editing, add/remove functionality. +- Tile16 Editing: Implement the core editor to create, modify, and store tile16 data. +- Palette Editing: Finalize palette editor UI and saving of palette groups. +- Dungeon Maps: Introduce map layouts and tile-based editing for dungeons. + +## 0.4.X +- Dungeon: Implement room object draw and edit functionality. +- Graphics Sheets: Complete editing, saving, and re-importing of sheets. +- Project Refactoring: Clean up resource loading and memory usage. + +## 0.5.X +- 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.6.X +- 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.7.X +- Cross-Platform Stability: Test and refine builds across Windows, macOS, iOS, and Linux. +- Plugin/Integration Framework: Provide hooks or scripting for community add-ons. + +## 0.8.X +- Performance Optimizations: Remove bottlenecks in rendering and data processing. +- Documentation Overhaul: Update manuals, guides, and in-app tooltips. + +## 0.9.X +- 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 +- Stable Release: Final, production-ready version. +- Changelog: Comprehensive summary of all changes since 0.0.0.