1. Getting Started

What is This Program

This program is a continuation of Fracture17 and DesiacX's Code Menu builder: focusing primarily on providing a simple means of configuring different aspects of the menu without needing to edit and recompile the builder's actual code, while also providing additional menu features and internal infrastructural improvements.

Quickstart Instructions

To install the menu into a build in its default configuration, follow these instructions:

1. Navigate to the Releases page, and download the latest version of the program.
2. Extract the folder contained in the downloaded .zip file.
3. Run the program executable corresponding to the desired menu configuration. To build a menu for general play on both Console and Dolphin, simply run the "Offline" executable. To instead build a menu specifically configured for Dolphin Netplay, run the "Netplay" executable! Provided the program runs successfully, you should find your newly generated code menu and any accompanying files in the "Code_Menu_Output" folder! Generated files are as follows:
   • "data.cmnu" (or "dnet.cmnu", if using Netplay executable)
     • Contains the "raw data" side of the menu, including line/page definitions, default line settings, and other configuration details.
     • Should be placed in "pf/menu3/".
   • "CodeMenu.asm" (or "Net-CodeMenu.asm", if using Netplay executable)
     • Contains the code that drives menu navigation, as well as any internally implemented code menu features!
     • Should be placed as follows:
       • "CodeMenu.asm": Place in "Source/CodeMenu/" if that folder exists in your build. Otherwise, place in "Source/Project+/".
       • "Net-CodeMenu.asm": Place in "Source/Netplay/".
   • "Code_Menu_Changelog.txt" (or "Net-Code_Menu_Changelog.txt", if using Netplay executable)
     • Contains a log detailing the settings applied in building the menu, as well as any actions taken by the menu builder itself (eg. backing up and overwriting files, rebuilding the GCTs, etc).
     • Doesn't need to be moved.
   • "Code_Menu_Options.xml" (or "Net-Code_Menu_Options.xml", if using Netplay executable)
     • Contains a summary of every page in the menu, detailing the default values and value ranges of every interact-able line on each page.
     • Doesn't need to be moved.
4. Place your generated ".cmnu" and ".asm" files in their respective locations, and use GCTRM to rebuild your "RSBE01.gct" and "BOOST.gct" (or "NETPLAY.gct" and "NETBOOST.gct" after using the Netplay executable). Or, alternatively, follow the below instructions to have this step automatically completed for you!

Info On Automatic File Placement and GCTRM

If you place the zipped folder in its entirety into your build folder (ie. such that the entire folder is where your "pf", "rp", and "Source" folders are), the program will additionally offer to copy the produced files into their appropriate locations (as well as backup any existing files). If the program also detects the GCTRM executable and the necessary code files ("RSBE01.txt" and "BOOST.txt" for offline builds, or "NETPLAY.txt" and "NETBOOST.txt" for netplay builds), the program will also offer to run GCTRM for you, backing up and updating your .GCTs automatically.

Note: If the program offers to copy your files into the appropriate locations, but doesn't prompt you to run GCTRM, it's because it couldn't find the necessary code files in the build folder. This is especially prone to happening when trying to run the "Netplay" executable without having "NETPLAY.txt" or "NETBOOST.txt" files in your build folder, as these files do not come with some versions of P+EX. Make sure those exist in your build folder, then run the program again.