Files
yaze/docs/getting-started.md
2024-08-11 11:15:14 -04:00

1.9 KiB

Getting Started

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.

Please note that this project is currently a work in progress, and some features may not be fully implemented or may be subject to change.

General Tips

  • Experiment flags determine whether certain features are enabled or not. To change your flags, go to File -> Options -> Experiment Flags or open the SettingsEditor tab.
  • Backup files are enabled by default. Each save will produce a timestamped copy of your ROM before you last saved. You can disable this feature in the settings.

z3ed cli

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

Extending Functionality

In addition to the built-in features, this software provides a pure C library interface and a Python module that can be used for building extensions and custom sprites without assembly.

This feature is still in development and is not yet fully documented.