Site Tools


dev:tools_site

Tools Site

The Tools Site is a utility to help convert images into Zeromus sprites, midi files into Harp songs, and set a specific sprite or song for an already generated FE ROM.

Once you've followed the setup guide for being able to generate seeds from the command line, you can run the tools site from the fetools directory: python tool_site.py <rompath> and then navigate in a browser to localhost:8082.

Zeromus Sprites

Once the site is running locally, click on Z Sprites Tool to navigate to that section of the site. There you can create new sprites, edit existing sprites, generate a test ROM, compile the sprite into the code necessary to get it into a ROM, download the .asset file for that sprite, and download all .asset files as a zip archive, or generate the catalog that you'll copy into the FreeEnt folder to actually have your sprites used by the randomizer generation.

Create New Asset

At the top of the /z page, there's a Create new asset link. Click that to navigate to /z/new which is the interface for adding a new sprite to your tools site. See Zeromus sprites for instructions and tips in actually making the image.

The create/edit page for an individual sprite has three sections:

  1. Information/Metadata
  2. Action buttons for testing/compiling the sprite
  3. Save and Delete buttons
Sprite Information and Metadata

This section has four properties: id, name, png, and description. The id is an auto-generated UUID, you don't have anything to do here. The name field has an implicit max length of 10 characters. You can have more, but the name will be truncated after 10 characters in game. It is, of course, tradition to have names end in mus. The description field gets written into files, but is currently not used anywhere in the randomizer; it's probably a good idea to leave notes about the source of the image or maybe creator credit.

Action Buttons
  • Download PNG - Downloads a png with the file using the full name you provided as the file's name.
  • Test ROM (and -vintage variant) - creates a ROM with a quick automated Z fight to show you your sprite and allow for quick iteration.
  • Compile F4C (and -vintage variant) - creates a .f4c file suitable for replacing specific sprites in an already generated ROM.
Save and Delete
  • Save saves the .asset to your ./fe-tools/assets/z folder. This does not remove the sprite from the catalog of sprites that the generator will pull from for randomization
  • Deletes the .asset file for this Z sprite from your ./fe-tools/assets/z folder. This does not remove the sprite from the catalog of sprites that the generator will pull from for randomization

Z Sprites list

This page in the tool lists all sprites that can be found under your ./fe-tools/assets/z folder in a .asset file. From here, you can hover over each entry to see the .png, generate a test ROM, create a .f4c file, and download the .asset file. There's also a link to download all .asset files, and a button to generate the full catalog of sprites.

The Generate full catalog button creates a .zip called zsprites_catalog.zip that contains .asset and .vintage.asset files for each of the assets in the ./fe-tools/assets/z folder, as well as a catalog file. The catalog consists of the ids of all your .asset files, one per line.

To update the list of what sprites your generator will pull from when creating a seed, copy the unzipped contents of this folder to your ./FreeEnt/compiled_zeromus_pics folder. You will want to make sure to overwrite files of the same name (or at least the catalog) when you copy these files.

Harp Songs

Details coming sometime!

Rescripter

Details coming sometime!

dev/tools_site.txt · Last modified: 2024/08/18 23:59 by wylem