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 to manage your Project
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 (R) โ
โ Update (U) โ
โ Package (P) โ
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโค
โ Save (S) โ
โ Edit (E) โ
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโค
โ Reload configuration (C) โ
โ Reload profiles โ
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโค
โ View console output (V) โ
โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโค
โ Exit (ESC) โ
โฐโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฏ
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 docs/tools/Callisto folder.
tl;dr Use "Edit" to launch Lunar Magic, use "Update" when you make any changes.
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:
- Copy the your patch file into to the resources/patches folder. (You can quickly get there using the toolbar button.)
- Add its path to the list in "patches.toml" (found in the buildtool folder) following the format of the existing items. Pressing the toolbar button will open this list in a text editor.
To remove a patch:
- Delete (or comment out) the reference to that patch from that same list in "patches.toml".
- 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:
- 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.
- Update PIXI's "list.txt" with the new sprite. (Pressing the toolbar button will open this list in a text editor.)
- 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 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:
- 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.
- 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.)
- 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 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:
- 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.
- 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.)
- 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 docs/tools folder..
Adding Music with AddMusicK
To add new music to your project:
- 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.
- Update the "Addmusic_list.txt" with your changes. (Pressing the toolbar button will open this list in a text editor.)
- 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 docs/tools folder.