🏠
Baserom Directories

Contents


"buildtool" Folder

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.

ItemDescription
colors.tomlConfiguration for the colors seen in Callisto's console output.
project.tomlContains Callisto settings for the whole project.
resources.tomlContains configuration options for resources used by Callisto.
tools.tomlContains configuration options related to tools used by Callisto.
user.tomlContains user-specific configuration options, such as the default emulator used by Callisto.


"docs" Folder

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.

ItemDescription
baserom_readmeThe folder containing all the baserom's readme files.
retry_systemThe readme files for the retry system.
toolsIn an initialized baserom, all the readme files for each tool will be here.

"resources" Folder

All the build resources for you project are in here. Patches, initial setup files, map16, palettes, etc.

ItemDescription
globalFolder for all global resources in a rom that are exported by callisto.
initial_patchesContains a clean BPS patch for each FastROM and SA-1 that are used by Callisto when building the rom.
levelsPretty self-evident, all the exported level files.
map16Import-able Map16 template files for a bunch of things in the baserom.
original_graphicsA back-up of the original, unmodified vanilla graphics in case they are needed.
palettesImport-able palette files for things in the baserom, namely the Poison Mushroom and Pink berry.
patchesAll of the Asar patches that Callisto applies at build time.
Demo Level.mwlA back-up copy of the baserom's demo level.
Info Level.mwlA back-up copy of the baserom's information level.

"shared" Folder

This folder contains files that are shared between tools and resources, typically variable definitions and configuration files.

ItemDescription
definesA folder of common definitions for resources.
freeram.asmA file containing all used FreeRAM as shared defines.

"tools" Folder

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.

ItemDescription
addmusickThe folder for AddMusicK and related files. .
flipsContains Floating IPS tool for creating BPS patches.
gpsContains the GPS block insertion tool and related files.
initA folder with files used by the initialization script.
lunar_magicFolder for Lunar Magic.
pixiContains the PIXI sprite insertion tool and related files.
uberasmtoolContains UberASMTool and all related files.

"workspace" Folder

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.

ItemDescription
ExGraphicsFolder containing all the baserom ExGraphics.
GraphicsFolder containing all the exported vanilla graphics.
sysLMRestoreNot included in the baserom, but will appear when starting work in Lunar Magic as part of its restore feature.
*.dscFile that has all the block descriptions that show up in Lunar Magic. Generated by GPS.
*.extmodThis is a bit of metadata generated by UberASMTool stating its version number.
*.m16Internal Map16 data for how vanilla sprites display in Lunar Magic.
*.mscFile generated by AddMusicK that Lunar Magic uses to display custom music in its menus.
*.mw2Contains metadata for displaying sprites with their graphics in Lunar Magic.
*.mwtMetadata file that Lunar Magic uses to display sprites in the list of "Collections of Custom Sprites". Generated by PIXI.
*.s16Internal Map16 data for how custom sprites display in Lunar Magic. Updated by PIXI.
*.smcThis is your hack.
*.sscFile that has all the sprites descriptions that appear in Lunar Magic. Generated by PIXI.