Super Mario 3D World (+ Bowser's Fury) Randomizer is a stage randomizer for Super Mario 3D World (Switch)!
The release executable is Windows only, to build for macOS or Linux, see the Building section further down this README.
You can also run from source if you are using macOS or Linux by opening this project in PyCharm after cloning this repository to a suitable directory.
Select a valid unmodified RomFS dump (the root of the RomFS directory - contains folders such as StageData, SystemData, etc.) of Super Mario 3D World + Bowser's Fury (either v1.0.0 or v1.1.0), enable any additional options and then hit the 'Randomize!' button and wait for the pop-up window to tell you the process has finished, this should generate a folder called SM3DWR-<seed> (with 'seed' being the seed used by the random number generator).
Go to the relevant section based on what option you selected for 'Output directory structure' in the settings (Console or Emulator).
Atmosphere and SimpleModManager (Recommended)
With Atmosphere and SimpleModManager - on the root of your microSD card, go to mods/Super Mario 3D World + Bowser's Fury (create these folders if they don't exist) and copy the newly generated SM3DW-<seed> folder to this location. Then, on console, make your way to SimpleModManager and enable the mod, then you're free to play!
Make sure that if you have multiple seeds present in your mods folder, have only one activated at a time.
With Atmosphere - on the root of your microSD card, go to atmosphere (remove any existing mods for Super Mario 3D World + Bowser's Fury within this location after safely backing up whatever was there to avoid possible conflicts) and copy the contents folder from inside the newly generated SM3DW-<seed> folder to this location (contents is only created when the 'Console' output directory structure option is selected), then you're free to play!
With Ryujinx - open Ryujinx, right click 'Super Mario 3D World + Bowser's Fury' and click on 'Open Mods Directory', this should open a new window within the mod folder. From there, copy the newly generated SM3DWR-<seed> folder into said mod folder (if you didn't select here as the output directory already with the 'Emulator' output directory structure option is selected). To check whether it is enabled, right click 'Super Mario 3D World + Bowser's Fury and click 'Manage Mods' and enable the mod folder if it isn't already, then you're free to play!
Note: Yuzu is not directly supported, so it is recommended to go with Ryujinx if you want to use an emulator.
Playing with a mismatched version (e.g. v1.0.0 RomFS randomizer base with the game on v1.1.0 or vice versa) may have unintended consequences.
Enable with other mods at your own risk, as this mod is only designed to be compatible with the vanilla game.
- The screen wipe effects for Lucky Houses and the Coin Express may not be correct under some circumstances.
- Stamps do not randomize with stage so the stamp screen is not fully functional. Stamps retain their original stage slot and do not follow the stage they were present in before randomization e.g. Super Bell Hill's stamp will stay at World 1-1 even if Super Bell Hill has been randomized to any other stage. For stage slots that didn't originally contain stamps but do after randomization, the collected stamp does not get added to the stamp screen but still contributes to the stamp counter.
- The course list may crash the game due to the modified StageList.byml.
- Some stage numbers are glitched due to the modified StageList.byml.
- The World Warp Pipes which should take you to the next world do not work and just kick you out of the stage if the stages containing them are not on World 1-2 or World 4-2.
- Sometimes, with randomized music, the music may sometimes cut out abruptly.
- Lucky Houses and the Coin Express may not disappear after use, but they correctly cannot be re-entered due under some circumstances as they may use the Toad House StageType to fix potential softlocks. However, this means their world map path will be undone when any of the conditions for respawning Toad Houses are met (game overs, etc.), at which point you can re-enter the Lucky House or Coin Express to redo the world map path at that section.
- If a non-boss blockade is locked behind a Bowser statue, the music does not play after you enter it.
- The music may stop playing after dying on the Coin Express until reaching the roulette at the end of the stage under some circumstances.
- The Goal Poles for 'The Great Goal Pole' and 'Back to Hands-on Hall' can never be changed due to the runaway Goal Pole not being able to change its appearance to the castle Goal Pole or the ending Goal Pole.
- Wii U support.
- Bowser's Fury island randomizer.
- Character statistics randomizer.
- More intricate language randomizer.
- Doing something with the World Warp Pipes in Koopa Troopa Cave and Piranha Creeper Creek.
- Checking for and downloading updates.
To build this software, open this project in PyCharm using your own Python environment (virtual is recommended) after cloning the repository to a suitable directory and run pip install -r requirements.txt in the built-in terminal.
Then run in the same terminal:
python -m nuitka main.py --standalone --include-data-dir=maps=maps --include-data-files=ico.ico=ico.ico --windows-icon-from-ico=ico.icofor Windows.python -m nuitka main.py --standalone --include-data-dir=maps=maps --include-data-files=ico.ico=ico.ico --macos-create-app-bundle --macos-app-icon=ico.icofor macOS.python -m nuitka main.py --standalone --include-data-dir=maps=maps --include-data-files=ico.ico=ico.icofor Linux.
The resulting output will be in a folder called main.dist.
If you need help with the randomizer in any way, be sure to try and get in touch with me via my Discord.