FF6WC command line configuration tool #31
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Initial commit. Code utilizes the memory.rom object from WorldsCollide. Use config.set_config_rgb(rom, name, values) to change the default window coloration settings in the ROM. name is "Window1", "Window2", etc., or "Font". values is the RGB triple shown in the configuration menu [R, G, B].
Proof-of-concept for patching an already-patched FF6wc rom to customize default settings. Currently supports: - Bat.Mode (False = "Active", True = "Wait") - Bat.Speed (1--6) - Msg.Speed (1--6) - Cmd.Set (False = "Window", True = "Short") - Window palettes (1--8, seven RGB triplets each) - Font palette (one RGB triplet) Does not currently support the following, which are all zero by default and therefore have no default value stored in ROM. Supporting these will require some additional memory use. - Gauge (on/off) - Sound (stereo/mono) - Cursor (reset/Memory) - Reequip (optimum/Empty) - Controller (single/multiple) - Mag.Order (1--6)
Python routine for command-line patching all default configuration options, including: Bat. Mode, Bat. Speed, Msg. Speed, Cmd.Set, Gauge, Sound, Cursor, Reequip, Mag. Order, Font color, Wallpaper, and Window palettes. See Readme.md for examples of usage. Note this uses a version of memory.rom.ROM() that allows bypassing the valid_rom_file check, in order to allow post-patching of FF6wc roms. Technical notes: New code was required to save default configurations to the ROM for several options that were previously just defaulted to zeros. This code (12 bytes) was added at memory address C3/FC18--C3/FC23, which was free in several patches of wc.py version 1.0.1.
Python routine for command-line patching all default configuration options, including: Bat. Mode, Bat. Speed, Msg. Speed, Cmd.Set, Gauge, Sound, Cursor, Reequip, Mag. Order, Font color, Wallpaper, and Window palettes. See Readme.md for examples of usage. Note this uses a version of memory.rom.ROM() that allows bypassing the valid_rom_file check, in order to allow post-patching of FF6wc roms. Technical notes: New code was required to save default configurations to the ROM for several options that were previously just defaulted to zeros. This code (12 bytes) was added at memory address C3/FC18--C3/FC23, which was free in several patches of wc.py version 1.0.1.
Updated command-line configurator. Version 2 uses WC-style dynamic memory allocation to add the explicit memory location for all configuration bytes (modification in WorldsCollide/Settings/__init.py). wc_config.py reads the memory location from the ff6wc.smc rom and updates the configuration bytes as requested. This should solve all issues with memory conflicts.
Updated command-line configurator. Version 2 uses WC-style dynamic memory allocation to add the explicit memory location for all configuration bytes (modification in WorldsCollide/Settings/__init.py). Running the configuration tool "wc_config.py -i ff6.wc <arguments>" reads the memory location from the ff6wc.smc rom and updates the configuration bytes as requested. This should solve all issues with memory conflicts.
Revert unused changes to rom.py
…llide into customize_config
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This branch uses the WC memory allocation utilities to add explicit default configuration bytes in generated ff6wc.smc roms. These default configuration bytes allow the use of the included command-line configuration tool, "wc_config.py," to set default configuration options in a patched ff6wc.smc rom. The configuration utility reads the location of the configuration bytes from the ff6wc rom, so this solution should be generally compatible with any further codebase updates using WC memory allocation.
Relevant changes are as follows: