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

11
docs/getting-started.md
View File

@@ -37,7 +37,7 @@ This feature is still in development and is not yet fully documented.
| 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. |
| Asar Patching | Complete | Apply Asar 65816 assembly patches to ROM. |
## Command Line Interface
@@ -45,9 +45,12 @@ Included with the editor is a command line interface (CLI) that allows you to pe
| 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 |
| Apply Asar Patch | asar | patch.asm [--rom=file] | Complete |
| Extract Symbols | extract | patch.asm | Complete |
| Validate Assembly | validate | patch.asm | Complete |
| Apply BPS Patch | patch | patch.bps [--rom=file] | Complete |
| Create BPS Patch | create | src_file modified_file | In progress |
| Asar Patch (legacy) | -asar | asm_file rom_file | Complete |
| Open ROM | -o | rom_file | Complete |
| Backup ROM | -b | rom_file [new_file] | In progress |
| Expand ROM | -x | rom_file file_size | Not started |