Merge Game Origin Rewrite branch and master

.github/workflows/build.yml

@@ -4,7 +4,7 @@ on: [push]
 
 jobs:
   Wii:
-    runs-on: ubuntu-20.04
+    runs-on: ubuntu-latest
     timeout-minutes: 10
 
     container:
@@ -19,7 +19,7 @@ jobs:
 
       - name: Install BrainSlug
         run: | 
-          git clone https://github.com/Chadderz121/brainslug-wii
+          git clone -b atof https://github.com/InvoxiPlayGames/brainslug-wii.git
           cd brainslug-wii
           make install
           cd ..
@@ -30,7 +30,7 @@ jobs:
           make wii -j2 DEBUG=1
 
       - name: Upload binaries (debug)
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v4
         with: 
           name: RB3Enhanced-Wii-Debug
           path: out/RB3Enhanced.mod
@@ -41,14 +41,25 @@ jobs:
           make wii -j2
 
       - name: Upload binaries (no-debug)
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v4
         with: 
           name: RB3Enhanced-Wii-NoDebug
           path: out/RB3Enhanced.mod
 
+      - name: Compile (bank8-debug)
+        run: |
+          make clean
+          make wii -j2 DEBUG=1 BANK8=1
+
+      - name: Upload binaries (bank8-debug)
+        uses: actions/upload-artifact@v4
+        with: 
+          name: RB3Enhanced-Wii-Bank8-Debug
+          path: out/RB3Enhanced.mod
+
   Xbox:
     if: github.repository == 'RBEnhanced/RB3Enhanced'
-    runs-on: windows-2019
+    runs-on: windows-2022
     timeout-minutes: 10
 
     steps:
@@ -72,7 +83,7 @@ jobs:
           make xbox -j2 DEBUG=1
 
       - name: Upload binaries (debug)
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v4
         with: 
           name: RB3Enhanced-Xbox-Debug
           path: out/RB3Enhanced.dll
@@ -85,7 +96,7 @@ jobs:
           make xbox -j2
 
       - name: Upload binaries (no-debug)
-        uses: actions/upload-artifact@v2
+        uses: actions/upload-artifact@v4
         with: 
           name: RB3Enhanced-Xbox-NoDebug
           path: out/RB3Enhanced.dll

.gitignore

@@ -11,8 +11,17 @@ build_xbox/
 # wii build artifacts
 build_wii/
 *.mod
+# ps3 build artifacts
+build_ps3/
+*.sprx
+*.prx
+# gcc build artifacts
 *.elf
 *.map
 *.o
 # automatically generated files
-version.h
+version.h
+# OS artifacts
+Thumbs.db
+desktop.ini
+.DS_Store

.vscode/c_cpp_properties.json

@@ -9,6 +9,7 @@
             "defines": [
                 "_DEBUG",
                 "_XBOX",
+                "_PPC_",
                 "RB3E",
                 "RB3E_XBOX",
                 "RB3EDEBUG"
@@ -35,6 +36,26 @@
             "compilerPath": "C:/devkitPro/devkitPPC/bin/powerpc-eabi-gcc.exe",
             "cStandard": "c89",
             "intelliSenseMode": "gcc-x86"
+        },
+        {
+            "name": "Wii (Bank 8)",
+            "includePath": [
+                "${workspaceFolder}/include",
+                "C:/devkitPro/bslug/include"
+            ],
+            "defines": [
+                "_DEBUG",
+                "GEKKO",
+                "HW_RVL",
+                "__wii__",
+                "RB3E",
+                "RB3E_WII",
+                "RB3E_WII_BANK8",
+                "RB3EDEBUG"
+            ],
+            "compilerPath": "C:/devkitPro/devkitPPC/bin/powerpc-eabi-gcc.exe",
+            "cStandard": "c89",
+            "intelliSenseMode": "gcc-x86"
         }
     ],
     "version": 4

BUILDING.md

@@ -1,31 +1,42 @@
 # Building RB3Enhanced
 
-RB3Enhanced is a cross-platform mod for both Xbox 360 and Wii. It's designed to be compiled on a Windows system, however both versions are able to compile on macOS and Linux.
+RB3Enhanced is a cross-platform mod for both Xbox 360 and Wii. It's designed to
+be compiled on a Windows system, however both versions are able to compile on
+macOS and Linux via Wine.
 
 ## Prerequisites
 
-* [devkitPPC](https://devkitpro.org/wiki/Getting_Started) (for Wii compilation)
-* [BrainSlug](https://github.com/Chadderz121/brainslug-wii/blob/master/INSTALLING) (for Wii compilation)
+* [devkitPro with devkitPPC](https://devkitpro.org/wiki/Getting_Started)
+* [InvoxiPlayGames/BrainSlug](https://github.com/InvoxiPlayGames/brainslug-wii/blob/master/INSTALLING)
 * Xbox 360 SDK, with build tools installed (for Xbox compilation)
-* Make \*, \*\*
+* Make \*
 
-You do not need devkitPPC to compile the mod for Xbox, and you do not need the Xbox 360 SDK to compile the mod for Wii.
+The environment variable `XEDK` must be set to the install directory for the
+Xbox 360 SDK, and the environment variable `DEVKITPPC` must be set to the
+install directory for devkitPPC. The installers for the respective toolchains
+will automatically do this for you.
 
-The environment variable `XEDK` must be set to the install directory for the Xbox 360 SDK, and the environment variable `DEVKITPPC` must be set to the install directory for devkitPPC. The installers for the respective toolchains will automatically do this for you.
-
-If compiling the Xbox 360 version under macOS or Linux, set the environment variable `WINDOWS_SHIM` to the path to your Wine executable. Note that some Wine versions may not work correctly with MSVC. You will also have to ensure `XEDK` is set to a path accessible under Wine, e.g. `Z:\Users\emma\xedk\`.
-
-*\* There is a build script provided as `make_xbox.bat` that will compile using only the Xbox 360 SDK. This is not recommended.*
-
-*\*\* On Windows, the only tested configuration is with Make installed via MSYS2. Any other configuration has not been tested, and may not work.*
+If compiling the Xbox 360 version under macOS or Linux, set the environment
+variable `WINDOWS_SHIM` to the path to your Wine executable. Note that some Wine
+versions may not work correctly with MSVC. You will also have to ensure `XEDK`
+is set to a path accessible under Wine, e.g. `Z:\Users\emma\xedk\`.
 
+*\* On Windows, the only tested configuration is with Make installed via
+devkitPro's MSYS2. Any other configuration has not been tested, and may not
+work.*
 
 ## Compilation
 
-Open a Terminal (or Command Prompt) window in the same folder you have cloned the source code into.
+Open a Terminal (or Command Prompt) window in the same folder you have cloned
+the source code into.
 
-* To build for Xbox 360, type `make xbox`. A DLL file will be output at `out/RB3Enhanced.dll`, that can then be loaded with RB3ELoader or a modified Rock Band 3 XEX.
-* To build for Wii, type `make wii`. A MOD file will be output at `out/RB3Enhanced.mod`, that can then be loaded with RB3ELoader or the BrainSlug channel.
-* Typing `make` or `make all` will compile both. Adding `-jX` (where X is your processor's thread count) will speed up compliation times.
+* To build for Xbox 360, type `make xbox`. A DLL file will be output at
+  `out/RB3Enhanced.dll`, that can then be loaded with the RB3ELoader Dashlaunch
+  plugin, or the Xenia patch.
+* To build for Wii, type `make wii`. A MOD file will be output at
+  `out/RB3Enhanced.mod`, that can then be loaded with the RB3Enhanced launcher.
+* Typing `make` or `make all` will compile both. Adding `-jX` (where X is your
+  processor's thread count) will speed up compliation times.
 
-Adding `DEBUG=1` to the make command will build a version of RB3E that will output more debugging information to the logs.
+Adding `DEBUG=1` to the make command will build a version of RB3E that will
+output more debugging information to the logs.

CONTRIBUTING.md

@@ -1,24 +1,45 @@
 # Contributing to RB3Enhanced
 
-We welcome all contributions to help make RB3Enhanced a better mod, by improving existing features or adding new ones.
+We welcome all contributions to help make RB3Enhanced a better mod, by improving
+existing features or adding new ones.
 
 ## Codebase
 
-* Visual Studio Code config files are included in the repository, so if you are using VSCode as your IDE, make sure it is following this file.
-* For cross-platform compatibility reasons, the codebase aims to be C89 / ANSI C. Variables must be defined at the start of functions rather than inline.
-    * Wii-specific implementations (must be guarded by #ifdef RB3E_WII) may be compliant GNU C99.
-    * Xbox-specific implementations (must be guarded by #ifdef RB3E_XBOX) may be slightly non-compliant, as MSVC's C89 implementation is non-standard.
+* Visual Studio Code config files are included in the repository, so if you are
+  using VSCode as your IDE, make sure it is following this file.
+* For cross-platform compatibility reasons, the codebase aims to be C89/ANSI C.
+  Variables must be defined at the start of functions rather than inline.
+    * Xbox-specific implementations (must be guarded by `#ifdef RB3E_XBOX`) may
+      be slightly non-compliant, as MSVC's C89 implementation is non-standard.
+    * Wii or PS3-specific implementations (must be guarded by `#ifdef RB3E_WII`
+      and/or `#ifdef RB3E_PS3`) may be compliant GNU C99.
 * All indentations should be 4 spaces.
 * Try to adhere to any existing code styling already used in the codebase.
-* Function addresses should be added to `include/ports.h` in the respective platform section.
-* When adding a function reference (whether as a hook or as a callee), make sure to add a unique stub in `source/_functions.c` and definitions of the original function in a header file in `include/rb3`.
-* Please make sure all your contributions are able to be licensed under the GPLv2 or later. This means not using non-free or incompatibly licensed libraries or external code.
+* Function addresses should be added to the applicable
+  `include/ports_{platform}.h` header file.
+* When adding a function reference (whether as a hook or as a callee), make sure
+  to add a unique stub in `source/_functions.c` and definitions of the original
+  function in a header file in `include/rb3`.
+* Please make sure all your contributions are able to be licensed under the
+  GPLv2 or later. This means not using non-free or incompatibly licensed
+  libraries or external code.
+    * The output of LLMs (e.g. ChatGPT) is not compatible with the GPLv2. Please
+    don't use these to generate code when working on code in RB3Enhanced!
 
 ## Pull requests
 
-* Test your changes before submitting them as a pull request, to ensure that they don't crash.
-    * Emulators may mask fault behaviour, or return different results compared to a real console, so it's advised to use real hardware if possible.
-* If applicable, try to include port addresses for both Xbox 360 and Wii in your contribution.
-    * If you can't do this, guard the implementation behind #ifdef RB3E_{PLATFORM}.
-* It's recommended that you enable "Allow contributors to edit code" in your pull request, so quick fixes can be added by us before merging.
-* Try to keep a clean Git history.
+* Test your changes before submitting them as a pull request, to ensure that
+  they don't crash.
+    * Emulators may mask fault behaviour, or return different results compared
+    to a real console, so it's advised to use real hardware if possible.
+    * Let us know what platform you've tested on.
+* If possible, try to include port addresses for Xbox 360, Wii, PS3 and Bank 8
+  in your contribution.
+    * If you can't do this, guard the implementation behind
+    `#ifdef RB3E_{PLATFORM}`.
+* It's recommended that you enable "Allow contributors to edit code" in your
+  pull request, so quick fixes can be added by us before merging.
+* Try to keep a clean Git history.
+    * Don't make excessive commits and don't force push too often.
+    * If your PR hasn't been merged, try to keep it up to date with changes
+    in the `master` branch.

Makefile

@@ -18,6 +18,11 @@ ifeq ($(strip $(DEBUG)),1)
     DEFINES += RB3EDEBUG
 endif
 
+# if BANK8=1 then compile builds for bank 8 dev build
+ifeq ($(strip $(BANK8)),1) 
+    DEFINES += RB3E_WII_BANK8
+endif
+
 # Wii variables
 # =================
 # build directory for Wii compilation

README.md

@@ -1,32 +1,43 @@
 # RB3Enhanced
 
-RB3Enhanced is a mod for Rock Band 3 that adds new features, fixes some flaws and overall makes it a nicer experience, compatible with Xbox 360 and Wii. _(Note: RB3Enhanced requires a modified console. It will not work on a retail console.)_
+RB3Enhanced is a mod for Rock Band 3 that adds new features, fixes some flaws
+and overall makes it a nicer experience, compatible with Xbox 360 and Wii.
+_(Note: RB3Enhanced requires a modified console. It will not work on a retail
+console.)_
 
-For more information, check out https://rb3e.rbenhanced.rocks or join the [RBEnhanced Discord](https://discord.gg/6rRUWXPYwb).
+For more information, check out https://rb3e.rbenhanced.rocks, join the
+[RBEnhanced Discord](https://discord.gg/6rRUWXPYwb) or `#rbenhanced` on
+irc.libera.chat.
 
-If you want to contribute, check BUILDING.md and CONTRIBUTING.md for more information.
+If you want to contribute, check BUILDING.md and CONTRIBUTING.md for more
+information.
 
 ## Downloading
 
-* **(Recommended)** For the most tested and stable version, download from https://rb3e.rbenhanced.rocks/download.html
-* For the bleeding edge latest commit, download the latest debug build from https://nightly.link/RBEnhanced/RB3Enhanced/workflows/build/master
+* **(Recommended)** For the most tested and stable version, download from
+  https://rb3e.rbenhanced.rocks/download.html
+* For the bleeding edge latest commit, download the latest debug build from
+  https://nightly.link/RBEnhanced/RB3Enhanced/workflows/build/master
     * You will need files from the stable release to use debug builds.
 
 ## Features
 
 * Raised song limit, allowing you to have up to 8000 songs in your library.
 * Play custom songs on the latest update of Rock Band 3.
-* Access unlockables such as keys on guitar and in-game cosmetic items, without having to grind.
+* Unlock additional features such as keys on guitar and in-game cosmetic items.
 * Additional modifiers, like black backgrounds and gem colour shuffle.
 * Game origin icons in the setlist to see what game your songs came from.
-* Fixes the infamous infinite loading bug on modified Corona consoles and development kits.
-* Easy mod support by placing raw files in the game directory without repacking the archives.
+* Support and integration with [Rock Band 3 Deluxe](https://rb3dx.milohax.org)
 * Online multiplayer without using Xbox Live or Nintendo WFC.
-* Sending data from the game to another device, for stream overlays and status indicators.
+* Integration with [GoCentral](https://github.com/ihatecompvir/GoCentral)
 * ...and more!
 
 ## License
 
-RB3Enhanced is licensed under the GNU General Public License version 2 (or later, at your choice) as found in the LICENSE.txt file. All source files are subject to this license unless specified otherwise in the header.
+RB3Enhanced is licensed under the GNU General Public License version 2 (or
+later, at your choice) as found in the LICENSE.txt file. All source files are
+subject to this license unless specified otherwise in the header.
 
-RB3Enhanced makes use of the [inih library by Ben Hoyt](https://github.com/benhoyt/inih), under the 3-clause BSD license.
+RB3Enhanced makes use of the
+[inih library by Ben Hoyt](https://github.com/benhoyt/inih), under the 3-clause
+BSD license.