Callisto - Romhack Races Baserom

Callisto is the window into your project, it keeps track of the changes you make and is also the means by which you jump into editing your project and making updates.

╭callisto v*.*.*────────────────────────╮
│ your-project (C:\User\your-project)   │
├───────────────────────────────────────┤
│ Rebuild (B)                           │
│ Update (U)                            │
│ Package (P)                           │
├───────────────────────────────────────┤
│ Save (S)                              │
│ Edit (E)                              │
├───────────────────────────────────────┤
│ Reload configuration (C)              │
│ Reload profiles                       │
├───────────────────────────────────────┤
│ View console output (V)               │
├───────────────────────────────────────┤
│ Exit (ESC)                            │
╰───────────────────────────────────────╯

Using Callisto

The primary actions that you need to worry about are, and the ones you'll use most often are:

Edit – this will launch Lunar Magic that is included in the project. It is important that you always use this Lunar Magic as it is monitored by Callisto to track changes you make when you edit levels, the overworld, map16, etc. which it exports for safe keeping.
Update – the action you will use the most. Everytime you add new resoures, like new sprites or blocks, you must Update your project for those changes to be applied.
Rebuild – this action will entirely rebuild your project from scratch, it should be used sparingly. Callisto is also smart about when a Rebuild is required when you use the Update action and will do that automatically.
Package – when you need to create a BPS patch of your project this action will do it for you.

You can read up on more of these actions in detail in the Callisto documentation in the tools/Docs folder.

tl;dr Use "Edit" to launch Lunar Magic, use "Update" when you make any changes.

Configuring Callisto

In Callisto's folder you can find have several configuration files (in .toml format) and a bunch of other build tool related files for the baserom. The following are ones that you can readily edit to re-configure your project.

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.
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.

Other configuration files you likely don't need to edit in your usage of the baserom will be:

Item	Description
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.