GLE Guide

This guide can help you do the following with the Galaxy Level Engine:

• Set up a riivolution patch with GLE included for your mod
• Set up a hubworld
• Get a galaxy working

Other stuff may be read about on the official wiki.

What you will need

• GLE (Make sure not to download the template hack by accident!)
• Dolphin
• Whitehole
• WiiExplorer
• Scenaristar - You may want to build it yourself as there is no release with GLE support yet.
• A bit of knowledge on SMG2 modding.

_{Read more on the necessary knowledge here.}

"Initializing" GLE & Making an XML for your mod

First, download GLE. Make a new folder just for this. Go to GLE-V2\Riivolution and copy "GLE_V2" into your new folder.

Additionally, make a riivolution folder inside the new folder.

Inside the riivolution folder you just created, create a new xml. You can call it whatever.

_{Refer to this for the layout of the xml}

Rename GLE_V2 to whatever you called [YourHackName].

Edit your xml and put the xml lines where it specifies. You can get this code from GLE-V2\Riivolution\GLEV2_[REGION]-SB4[R]01.xml.

Make a copy for every region of your hack (USA, PAL, JPN, ... TWN and KOR are not supported atm, but should be in the future)

Add your ISO/WBFS to dolphin's game path. (Config->Paths->Add...)

Right click on your ISO/WBFS and click "Start with Riivolution Patches...".

_{If this does not show up you are on an OUTDATED version of dolphin!}

Open the XML that you just created and save a preset. Name it whatever your hack's name is. Then enable it and click start.

The game should be able to boot up, but won't be able to load a file. If this is the case...

GLE is now initialized!

Congratulations! Next we will be adding a hubworld. Don't add any other custom code quite yet.

Problem: Black Screen Loading Screen

This happens because your XML is setup wrong. It copies the code for GLE but doesn't copy the necessary files. Thus, it gives a file isn't exist exception. Make sure the folder name matches what you set [YourHackName] to.

Adding a hubworld

To make the BCSVs easy to edit, simply copy the files in GLE_V2 into SMG2/data/files (Replace if asked). You will have to copy these files over to your riivolution game files anytime you want that changed.

Open your workspace and add the hubworld template. Then, follow this guide. Be sure to also change YourHubworldGalaxyScenario.arc's root name.

Add some entries for the galaxy in GalaxyName.msbt, GalaxyNameShort.msbt, and ScenarioName.msbt, and we're done with that!

Now we are going to set up the SavePointList.

Archive: /ObjectData/SystemDataTable.arc, File: /SystemDataTable/SavePointList.bcsv

Recommended Values For Your Hubworld's SavePointList

ID	GalaxyName	ScenarioNo	ZoneName	MarioNo	Player	ResultPathId	EntryPathId	EntireLevelFlag
01	[YourHubworldName]2	1		0	-1	0	0	1

_{1: an entry with the ID of 0 is required; 2: Replace [YourHubworldName] with the internal name of your hubworld; Read more about the SavePointList here}

To make the menu say "Save And Quit" instead of "Return to World Map"

Archive: /StageData/[YourHubworldName]/[YourHubworldName]Map.arc, File: /Stage/jmp/List/ScenarioSettings¹

_{1: There is no .bcsv on the end of ScenarioSettings. This is intentional.}

Add a new row and activate whatever you want on this list.

Problem: Looping File Select

Make sure to create a new save file. You cannot use files that existed before the SavePointList was changed.

Congratulations!

Let me know if you have any problems. You may now add any additional custom code to your xml.

Adding a new galaxy

First of all, either Create a New Galaxy or Convert an Existing Galaxy.

Be sure to also change YourGalaxyScenario.arc's root name.

Add some entries for the galaxy in GalaxyName.msbt, GalaxyNameShort.msbt, and ScenarioName.msbt.

Add a SceneChangeArea and set obj_arg0 to 0. This is the index to the ZONE's ChangeSceneListInfo.

_{The other args can be read about here.}

Now time to edit the ChangeSceneListInfo.

Archive: /StageData/[YourHubworldZoneOrGalaxy]/[YourHubworldZoneOrGalaxy]Map.arc, File: /Stage/jmp/List/ChangeSceneListInfo¹

_{1: There is no .bcsv on the end of ChangeSceneListInfo. This is intentional.}

Read up on this as it is fairly straightforward.

If you converted a galaxy, you will need to change the GalaxyInfo so that stars will appear on the star select. Don't forget to copy over ALL the files you've modified to your riivolution space!

And we're done!

Congratulations on getting through this guide. If you need help, let me know in Discussions or on Discord. There is a LOT more to the galaxy level engine. I would recommend reading through some of the wiki pages, because they may inform you of features you weren't aware of.