The Romhack Races baserom is a Callisto-based project so the directory structure is best set-up for using that tool.
This folder contains Callisto, which is the build tool used by the baserom to assemble your project. Here you can find the configuration files for Callisto, in .toml format, as well as any other build tool related files for the baserom.
Baserom resource configuration files:
| Item | Description |
|---|---|
| exports.toml | A baserom configuration file to tell it what to export and where. |
| modules.toml | Definitions for the Callisto modules used by the baserom. |
| patches.toml | The full list of Asar patches used during build time. Edit this list to add or remove patches from your project. |
| variables.toml | Contains defined variables for your project. Here you can rename your project. |
Callisto-specific configuration files:
| Item | Description |
|---|---|
| build.toml | The overall build settings for the whole project. Contains the options for the initial clean patch, build order and output directories & format. |
| colors.toml | A default configuration file for Callisto to configure the colors of it's command-line user-interface. |
| tools.toml | A configuration file that has all the options for the tools that Callisto will run during build order. |
| user.toml | Can have any other preferred user settings, like emulator setup. |
All the readme files for the baserom (like the one you're currently reading) and those for other included resources and tools are stored here for your convenience.
| Item | Description |
|---|---|
| baserom_readme | The folder containing all the baserom's readme files. |
| retry_system | The readme files for the retry system. |
| tools | All the documentation for each tool will have been moved here after initialization. |
This folder contains all modified resources exported by Callisto from Lunar Magic. Things in this folder are your
| Item | Description |
|---|---|
| global | Folder for all global resources in a rom that are exported by callisto. |
| levels | Pretty self-evident, all the exported level files. |
| all_map16.map16 | A full export of your project's Map16. |
| shared_palettes.pal | A full export of your project's shared palette. |
All the build resources for you project are in here. Patches, initial setup files, map16, palettes, etc.
| Item | Description |
|---|---|
| initial_patches | Contains a clean BPS patch for each FastROM and SA-1 that are used by Callisto when building the rom. |
| map16 | Import-able Map16 template files for a bunch of things in the baserom. |
| original_graphics | A back-up of the original, unmodified vanilla graphics in case they are needed. |
| palettes | Import-able palette files for things in the baserom, namely the Poison Mushroom and Pink berry. |
| patches | All of the Asar patches that Callisto applies at build time. |
This folder contains files that are shared between tools and resources, typically variable definitions and configuration files.
| Item | Description |
|---|---|
| defines | A folder of common definitions for resources. |
| freeram.asm | A file containing all used FreeRAM as shared defines. |
This folder is where all the baserom tools are kept as well as any files and resources they use. If you are adding things to your project, you are adding them to the folders in this folder.
Do not run the tools from these folder directly. Callisto takes care of running all tools when using it.
| Item | Description |
|---|---|
| addmusick | The folder for AddMusicK and related files. . |
| flips | Contains Floating IPS tool for creating BPS patches. |
| gps | Contains the GPS block insertion tool and related files. |
| init | A folder with files used by the initialization script. |
| lunar_magic | Folder for Lunar Magic. |
| pixi | Contains the PIXI sprite insertion tool and related files. |
| uberasmtool | Contains UberASMTool and all related files. |
This folder is where your project lives and is the output directory for the build process. It will contain your project's rom, its Graphcs and ExGraphics, as well as any auxillary files used by the tools.
| Item | Description |
|---|---|
| ExGraphics | Folder containing all the baserom ExGraphics. |
| Graphics | Folder containing all the exported vanilla graphics. |
| sysLMRestore | Not included in the baserom, but will appear when starting work in Lunar Magic as part of its restore feature. |
| *.dsc | File that has all the block descriptions that show up in Lunar Magic. Generated by GPS. |
| *.extmod | This is a bit of metadata generated by UberASMTool stating its version number. |
| *.m16 | Internal Map16 data for how vanilla sprites display in Lunar Magic. |
| *.msc | File generated by AddMusicK that Lunar Magic uses to display custom music in its menus. |
| *.mw2 | Contains metadata for displaying sprites with their graphics in Lunar Magic. |
| *.mwt | Metadata file that Lunar Magic uses to display sprites in the list of "Collections of Custom Sprites". Generated by PIXI. |
| *.s16 | Internal Map16 data for how custom sprites display in Lunar Magic. Updated by PIXI. |
| *.smc | This is your hack. |
| *.ssc | File that has all the sprites descriptions that appear in Lunar Magic. Generated by PIXI. |