🏠
Baserom Basics

This article will go into some basic tasks when it comes to using the tools included in the baserom since it is a little different from a typical setup.

Contents


Using Callisto

Callisto is the build tool used by the baserom to assemble your project. You should run this tool at all times to perform updates to your project as well as have it actively watching your project to export and save edits.

Read more about how to use Callisto with your project on this page

Don't run any of the tools manually, use Callisto to update your project.


Adding or Removing Asar Patches

In the baserom, Asar patches are managed by the Callisto build tool and are all applied at build time. The files for all included patches are kept in subfolders the resources/patches folder.

To add a new patch:

  1. Copy the your patch file into to the resources/patches folder. (You can quickly get there using the toolbar button.)
  2. Add its path to the list in "patches.toml" (found in the tools/Callisto folder) following the format of the existing items. Pressing the toolbar button will open this list in a text editor.

To remove a patch:

  1. Delete (or comment out) the reference to that patch from that same list in "patches.toml".
  2. You are free to delete the patch file from resources/patches, but this isn't necessary.

Any changes made to the patches list will be applied the next time you run the "Rebuild" or "Update" action.

In versions 5.9 and earlier patches were in the "resources.toml" file.

Adding Sprites with PIXI

To add sprite resources to your project:

  1. Open the tools/PIXI folder (you can do this right from Lunar Magic with the button) and add your sprite files to the relevant folders in this directory.
  2. Update PIXI's "list.txt" with the new sprite. (Pressing the toolbar button will open this list in a text editor.)
  3. Do not run pixi.exe manually. Instead run the "Update" action in an open Callisto window or press the toolbar button to insert the new sprites.

For more information about use PIXI, check out PIXI's included README in the tools/Docs folder. Or, for a more in-depth explanation of how to use PIXI, check out this tutorial on SMW Central.


Adding Blocks with GPS

To add block resources to your project:

  1. Open the tools/GPS folder (you can do this right from Lunar Magic with the button) and add your block files to the relevant folders in this directory.
  2. Update GPS's "list.txt" with the new blocks, take care to not overwrite blocks that are already present in the baserom or use a Block ID that is already used. (Pressing the toolbar button will open this list in a text editor.)
  3. Do not run gps.exe manually. Instead run the "Update" action in an open Callisto window or press the toolbar button to insert the new blocks.

Start with Page 4 addresses in the block list (400 and up) to avoid conflicts with the baserom's blocks.

For more information about use GPS, check out GPS's included README in the tools/Docs folder. Or, for a more in-depth explanation of how to use GPS, check out this tutorial on SMW Central.


Adding UberASM with UberASMTool

To add new UberASM to your project:

  1. Open the tools/UberASMTool folder (you can do this right from Lunar Magic with the button) and add your UberASM files to the relevant folders in this directory.
  2. Update UberASMTool's "list.txt" with your changes, take care to not remove UberASM that is already present in the baserom. (Pressing the toolbar button will open this list in a text editor.)
  3. Do not run UberASMTool.exe manually. Instead run the "Update" action in an open Callisto window or press the toolbar button to insert the new UberASM.

For a more in-depth explanation of how to use UberASMTool, check out UberASMTool's included README in the tools/Docs folder.


Adding Music with AddMusicK

To add new music to your project:

  1. Open the tools/AddMusicK folder (you can do this right from Lunar Magic with the button) and add your music files to the relevant folders in this directory.
  2. Update the "Addmusic_list.txt" with your changes. (Pressing the toolbar button will open this list in a text editor.)
  3. Do not run any AddMusicK.exe manually. Instead run the "Update" action in an open Callisto window or press the toolbar button to insert the new music or sound effects.

For a more in-depth explanation of how to use AddMusicK, check out AddMusicK's included README in the tools/Docs folder.


Rename Your Project

By default, the project is named "RHRv5" and this is set in the tools/Callisto/variables.toml configuration file. If you would like your project to be called something else open that file and change the project_name definition.

[variables]

    # Feel free to change this!
    project_name = "RHRv5"

After updating this configuration (and saving the file), run a Rebuild action to make the change.