Differences

This shows you the differences between two versions of the page.

--- dev:tools_site [2024/08/18 23:59] – created (credit: Antidale) wylem
+++ dev:tools_site [2024/12/03 01:35] (current) – [Overview] antidale
@@ Line 39: / Line 39: @@
 ===== Rescripter =====
-Details coming sometime!
+==== Overview ====
+The Rescripter function allows the specification of Zeromus sprites and Harp songs after a seed is generated. Typically, this has been done to support donation incentives for marathons, or to showcase special selections for significant events.  In order to use Rescripter, you'll need a ROM, a ''.env'' file with at least the same ''FE_EMBEDDED_REPORT_KEY'' value, the ability to run an instance of the tools site, and the .f4c files for any sprites and songs you'd like to use.
+The Rescripter tool has four sections, one for uploading the FE Rom you're adjusting, one for one or more Zeromus sprites to apply to the ROM, one for one or more harp songs to apply to the ROM, and finally a ''Generate rescripts button''.
+=== The ROM ===
+To start with, upload the ROM you're looking to adjust. If you're doing this for a marathon, see if you can get a vetted seed some days in advance. The rescripting itself doesn't take much time, but giving yourself some buffer is always a good idea. Remember uploading an FE seed, and not the base FFIV ROM.
+=== Single Replacements ====
+To just replace a single Zeromus sprite, all you have to do is upload the ''.f4c'' file for the sprite you want to patch in. You can, but do not need to, add a label. The easiest way to get the ''.f4c'' file is to download it from the ''Compile F4C'' button for a sprite in the Z Sprites list, or on the sprite's specific edit page. Substituting in a vintage sprite requires going to the edit page.
+To just replace a single harp song, just add in the ''.f4c'' file for the song you'd like to patch in. Just like for a sprite, you can add in a label if you want, but it is not necessary.
+You can replace both a single Z sprite and a single Harp song without using labels, and you can replace only a sprite or only a song when doing this; there is no need to replace both.
+Once you have set your replacement data, click on the ''Generate rescripts'' button. The site will then perform the substitutions and download a `replacements.zip` file. Unzip that file to get your altered ROM, which will have ''.rescript'' appended just before the ''.smc'' in the file name.
+=== Batch Replacements ===
+If you are preparing a set of ROMs for a marathon with donation incentives, or otherwise need/want to do just one ''Generate rescripts'' button click, you can do so by using labels and uploading up to a total of four sprite and four songs. Each sprite and song will need their own label. The tool then will generate a Cartesian product of all the options (meaning: you will end up with a version of the seed with each possible pairing of a sprite and song), and when finished will download them all in a single `replacements.zip` file, which will unzip into a folder with the ROMs in it. Each ROM will be identified with the label you made for the sprite and for the harp song to help you select the correct one when it's time to provide it to the runners.

Free Enterprise Wiki

User Tools

Site Tools

Differences

Page Tools