Adjuster support

These are the basic adjuster files setting up for a new feature in the next release. Already randomized ROMs can be adjusted after the fact and have quickswap, fast menu, disable music, heartbeep rate, or a custom sprite applied or removed at the user's discretion with the checksum being properly updated. For now, the validity check for a randomized ROM is simply that it is exactly 2 MiB long and has a file name that ends in .sfc (while .smc is a valid SNES ROM file extension, no existing randomizer programs use it for output). This feature will need more updating with the new v28 features before it's ready for primetime; KevinCathcart's sprite selector will be an important part of this feature, and I believe variable speed fastmenu will be supported by the v28 base ROM so I'd want to make that selectable as well. For now, this should work as building blocks.
2025-10-21 20:21:32 -06:00 · 2017-12-12 08:17:52 -06:00
parent d9182a4adb
commit 704d9eb6c8
3 changed files with 437 additions and 4 deletions
--- a/Adjuster.py
+++ b/Adjuster.py
@@ -0,0 +1,49 @@
+import argparse
+import os
+import logging
+import textwrap
+import sys
+
+from AdjusterMain import adjust
+
+class ArgumentDefaultsHelpFormatter(argparse.RawTextHelpFormatter):
+
+    def _get_help_string(self, action):
+        return textwrap.dedent(action.help)
+
+
+if __name__ == '__main__':
+    parser = argparse.ArgumentParser(formatter_class=ArgumentDefaultsHelpFormatter)
+
+    parser.add_argument('--rom', default='ER_base.sfc', help='Path to an ALttP JAP(1.0) rom to use as a base.')
+    parser.add_argument('--loglevel', default='info', const='info', nargs='?', choices=['error', 'info', 'warning', 'debug'], help='Select level of logging for output.')
+    parser.add_argument('--fastmenu', help='Enable instant menu', action='store_true')
+    parser.add_argument('--quickswap', help='Enable quick item swapping with L and R.', action='store_true')
+    parser.add_argument('--disablemusic', help='Disables game music.', action='store_true')
+    parser.add_argument('--heartbeep', default='normal', const='normal', nargs='?', choices=['normal', 'half', 'quarter', 'off'],
+                        help='''\
+                             Select the rate at which the heart beep sound is played at
+                             low health. (default: %(default)s)
+                             ''')
+    parser.add_argument('--sprite', help='''\
+                             Path to a sprite sheet to use for Link. Needs to be in
+                             binary format and have a length of 0x7000 (28672) bytes,
+                             or 0x7078 (28792) bytes including palette data.
+                             Alternatively, can be a ALttP Rom patched with a Link
+                             sprite that will be extracted.
+                             ''')
+    args = parser.parse_args()
+
+    # ToDo: Validate files further than mere existance
+    if not os.path.isfile(args.rom):
+        input('Could not find valid base rom for patching at expected path %s. Please run with -h to see help for further information. \nPress Enter to exit.' % args.rom)
+        sys.exit(1)
+    if args.sprite is not None and not os.path.isfile(args.sprite):
+        input('Could not find link sprite sheet at given location. \nPress Enter to exit.' % args.sprite)
+        sys.exit(1)
+
+    # set up logger
+    loglevel = {'error': logging.ERROR, 'info': logging.INFO, 'warning': logging.WARNING, 'debug': logging.DEBUG}[args.loglevel]
+    logging.basicConfig(format='%(message)s', level=loglevel)
+
+    adjust(args=args)