To get started with the baserom you will need to run a set-up script to initialize your project by downloading all the tools and loading pre-configured files for use in the baserom.

The baserom is also cross-platform and depending on which version you downloaded there will be different scripts provided.

• Windows Setup
• Linux/Mac Setup
• Re-run Setup

The main purpose of these scripts is to keep the git repository for the baserom free from the binary files and executables that come with tools to avoid being in the sticky situation of re-distributing them with the baserom.

Windows

The batch script "setup.bat" in the main folder sets up the baserom for use–it does call some other PowerShell scripts that you can find in the setup folder–and has few main functions:

1. Run The Setup Script

Running setup.bat script will launch a new command line window where you will see the following menu.

----------------------
RHR Baserom v5 - Setup
----------------------

Welcome! To get started with the baserom, run both of the following steps:

1) Download and set up all baserom tools
2) Run a first build of the baserom in Callisto
0) Exit

Enter the number of your choice

• Step 1 will check if the tools required by the baserom are setup, and if not it will download them.
• Step 2 will build the baserom from scratch using Callisto so you can get right to hacking on your project.

If you are using Windows with a restrictive Execution Policy, you may have trouble running the setup script.

2. Use Callisto

After setup, launch the Callisto executable (found in tools/Callisto) to manage your project. Run "Edit" to launch Lunar Magic, using the "Update" action to apply changes.

Linux/Mac

The non-windows version of the baserom has several extra steps and dependencies required for you to be able to get going.

1. Install WINE

Version 11 is recommended for the ideal experience, but at least 10 would work. You can check the version by running wine --version in a terminal.

2. Install Program Dependencies

Set up .NET 8 (or higher) in your WINE prefix. This can be done manually or with winetricks:

$ winetricks dotnetdesktop8

3. Install Setup Dependencies

This will differ between operating systems, but you should use your OS's package manager to make sure the following executables available on your system (these may be available by default):

7z patch curl sed jq

4. Run The Setup Script

Run the setup shell script which will download all the tools required for the baserom.

$ chmod +x setup.sh
$ ./setup.sh

It is recommended after setup to run a Build action in Callisto to get a clean first build.

5. Use Callisto from the Terminal

Instead of running the Callisto executeable through WINE, it needs a workaround. You can use the provided `run-callisto.sh` shell script in a terminal to perform Callisto actions.

$ chmod +x run-callisto.sh
$ ./run-callisto.sh ACTION

Where ACTION is one of rebuild, update, save, edit, package, or profiles. See ./run-callisto.sh --helpb for more info.

Note: Running Callisto normally is not possible because it's text-based UI does not work within WINE.

Re-running Setup Scripts

At some point you may want to re-setup the baserom, or update a tool. You can do this in the baserom by deleting the hidden ".is_setup" file in a given tool's folder and running the of the setup script again which should ignore all other tools and already complete processes.

Important: Callisto uses a modified Asar DLL to track dependencies in a project and the Setup process replaces instances of Asar in each tool with Callisto's. So, if you are updating a tool you will need a copy of the modded DLL to make use of dependencies tracking.