reworked random placement

Author: andrelikesdogs

.vscode/launch.json

@@ -18,12 +18,12 @@
                 // "--shuffle-skybox",
                 // "--shuffle-text",
                 // "--shuffle-colors",
-                "--disable-cutscenes",
+                // "--disable-cutscenes",
                 // "--shuffle-instruments",
                 "SM64_US.z64"
             ],
             "env": {
-                "SM64R": "PLOT"
+                // "SM64R": "PLOT"
             }
         }
     ]

Config/sm64.vanilla.yml

@@ -507,6 +507,11 @@ collision_groups:
       - WATER_FLOWING
       - SLIPPERY
 
+# Define a list of behaviours that should be used for geometry. This can include
+# the rocks from JRB, platforms from RR or the 
+use_behaviour_geometry:
+  - 0x130005B4
+
 # Start object randomization section. Can be deeply nested with groups, sub-group, etc
 # This segment will define all randomizable objects, that will be moved around in a level.
 # - Groups can be created (without a "match") property to organize multiple different objects together

Data/configurableParams.json

@@ -107,64 +107,25 @@
     "help": "Shuffle Dialog text, for signs, npc dialog, level dialog and prompts."
   },
   {
-    "name": "disable-cutscenes",
-    "label": "Disable Cutscenes/Intro",
-    "category": "gameplay",
-    "type": "checkbox",
-    "default": {
-      "CLI": false,
-      "WEB": true
-    },
-    "help": "Disables some of the games cutscenes. (Peach Intro, Lakitu Intro, Bowser-Text on Entry)"
-  },
-  {
-    "name": "disable-starwarp",
-    "label": "Disable Star-Warp",
-    "category": "gameplay",
+    "name": "shuffle-instruments",
+    "label": "Instrument-Set Shuffle",
+    "category": "aesthetics",
     "type": "checkbox",
-    "disabled": "work-in-progress",
     "default": {
       "CLI": false,
       "WEB": false
     },
-    "help": "Disables automatically leaving the level when you collect a star. This way, all stars act like a 100-Coin star or a Bowser 8-Reds Star"
-  },
-  {
-    "name": "stardoor-requirements",
-    "label": "Stardoor Requirements",
-    "category": "gameplay",
-    "disabled": "work-in-progress",
-    "type": "select",
-    "options": [
-      { "value": "vanilla", "label": "Vanilla" },
-      { "value": "random", "label": "Random" },
-      { "value": "open", "label": "All Open" }
-    ],
-    "default": "vanilla",
-    "help": "Changes how the doors to levels require different amounts of stars to be collected beforehand. Random means all doors require stars, but the amount will be random. Open simply means all doors are open from the start."
+    "help": "Shuffles instrument sounds around. Many different objects and songs use different instrument sets, as the N64 can't load all at once. This will shuffle them around. Might be wacky."
   },
   {
-    "name": "keydoor-requirements",
-    "label": "Keydoor Requirements",
+    "name": "disable-cutscenes",
+    "label": "Disable Cutscenes/Intro",
     "category": "gameplay",
-    "disabled": "work-in-progress",
-    "type": "select",
-    "options": [
-      { "value": "vanilla", "label": "Vanilla" },
-      { "value": "open", "label": "All Open" }
-    ],
-    "default": "vanilla",
-    "help": "Changes how the locked keydoors in the castle work. Vanilla means you will require the usual keys from the Bowser fights. Open means they're simply open from the start."
-  },
-  {
-    "name": "shuffle-instruments",
-    "label": "Instrument-Set Shuffle",
-    "category": "aesthetics",
     "type": "checkbox",
     "default": {
       "CLI": false,
-      "WEB": false
+      "WEB": true
     },
-    "help": "Shuffles instrument sounds around. Many different objects and songs use different instrument sets, as the N64 can't load all at once. This will shuffle them around. Might be wacky."
+    "help": "Disables some of the games cutscenes. (Peach Intro, Lakitu Intro, Bowser-Text on Entry)"
   }
 ]

README.md

@@ -8,163 +8,133 @@
   </a>
 </p>
 
-
 # Super Mario 64 ROM Randomizer Generator
 
 This is a work in progress project to build an [OoT-Randomizer](https://www.ootrandomizer.com/)-style randomizer for Super Mario 64, that is highly configurable but easy to use.
 
 # Features
 
 - Works on all endianess' (`.z64`, `.n64`, `.v64`) and all regions (America, Europe, China, Japan, Japan Shindou).
-- Works on ROMhacks (**Please note:** Romhacks can be vastly different. Please contact us in the discord if you have any trouble.)
-- Randomizes Level Entries - Every Level will be a different one
-- Randomizes Castle Paintings - To visually match the entrance of the level it now leads to.
+- Randomizes level entries - Every level will be a different one
+- Randomizes Castle paintings - To visually match the entrance of the level it now leads to.
   - _New_: Levels without a castle painting will show a painting visually matching the original style, by the talented [Mika](https://not-very-artistic.tumblr.com/)
 - Byte alignment for running on real hardware. Default is `8`
-- Randomizes Dialog
-- Randomizes Music
-- Randomizes Mario's Outfit
-- Randomizes Coin Colors
-- Randomizes Objects in Level
-- Randomizes Musical Instruments
-- Randomizes Skybox
-- Disables Cutscenes
-- Disables Level Intros
-- ~~Disable Keydoors~~ (Currently disabled)
+- Randomizes dialog
+- Randomizes music
+- Randomizes mario's outfit
+- Randomizes coin colors
+- Randomizes objects in level
+- Randomizes musical instruments
+- Randomizes skybox
+- Disables cutscenes and level intros
 - ...many more to come
 
+This program theoretically works on romhacks. I don't have the time to create and maintain configurations for romhacks. If you have experience and want to contribute, please ping me and I will try and help you out.
 
 The application is supported on everdrive. To ensure everdrive compatibility, please change the name to a shorter one, as that seems to cause issues. For further help, please visit the Discord Server.
 
-
 Also auto extends ROM to work with the randomizer. If this fails, extend your ROM manually and use either [sm64extender](https://www.smwcentral.net/?p=viewthread&t=77343) or [Super Mario 64 ROM Extender](http://qubedstudios.rustedlogic.net/Mario64Tools.htm).
 
 # Web
+
 For extremely simple usage, simply use our existing web generator, found here: https://andrelikesdogs.github.io/sm64-randomizer/
 
 ![SM64 Randomizer Generator Web Edition](https://i.imgur.com/78OiLPZ.png)
 
 ### Usage
+
 Follow instructions on the website. Upload your original SM64 rom, select the settings and press "Queue for generation" you'll quickly receive your randomized ROM.
 
 # GUI
+
 The randomizer includes a simple GUI for easy setup without any knowledge about the command line. Simply download the latest [release](/releases/latest) and open `SM64 Randomizer GUI`.
 
 ![SM64 Randomizer GUI](https://i.imgur.com/erEk4Dh.png)
 
 ### Install
+
 1. Download the [latest release](/releases/latest)
 2. Extract **all files** in a folder of your liking
 3. Run SM64 Randomizer Generator.exe
 
 ### Usage
+
 1. Select an Input ROM
 2. Select an Output (will be automatically determined to <rom-name>.out.<file-extension>)
 3. Select your settings
+
 - Choose a custom seed to share with friends who use the same tool
 - Copy the settings string to copy your current settings to share with friends. Does not include seed.
+
 4. Press "Generate"
 5. Run output file on your emulator/console. :tada:
 
 # CLI
-For expert users who want to tinker with configurations, settings and test various roms, it's easier to use the program in CLI mode. To do this, run the application with additional arguments, and it will automatically work as a terminal tool. (For server owners: No graphical interface is required, if more than one argument is given.)
+
+For expert users who want to tinker with configurations, settings and test various roms, it's easier to use the program in CLI mode. To do this, run the application with additional arguments, and it will automatically work as a terminal tool.
 
 ### Install
+
 1. Download the [latest release](/releases/latest)
 2. Extract **all files** in a folder of your liking
 3. Run SM64 Randomizer Generator.exe in your terminal
 
 ### Usage
+
 ```
 python main.py ./Super_Mario_64_(U)_[!].z64 --shuffle-levels --shuffle-mario-color --shuffle-paintings match --seed 123
 ```
 
-_Note: Works on all versions of the game, as well as **ROM Hacks** (with some tweaking, contact us in [Discord](https://discord.gg/2ZYfhcB) for help)_
+_Note: Works on all regions of the original SM64_
 
 Output will be a file with the same name, ending in `.out.z64`. Run this on your emulator/console.
 
 ```
-  Super Mario 64 Randomizer  (Version: 0.8.0)
-
-usage: main.py [-h] [--no-extend] [--alignment ALIGNMENT] [--out OUT]
-               [--version] [--seed SEED]
-               [--shuffle-paintings {vanilla,match,replace-unknown,random}]
-               [--custom-painting-author {disable,mika}] [--shuffle-skybox]
-               [--shuffle-entries] [--shuffle-mario-outfit] [--shuffle-music]
-               [--shuffle-objects] [--shuffle-colors] [--shuffle-text]
-               [--disable-cutscenes] [--disable-starwarp]
-               [--stardoor-requirements {vanilla,random,open}]
-               [--keydoor-requirements {vanilla,open}] [--shuffle-instruments]
+  Super Mario 64 Randomizer  (Version: 0.10.1)
+
+usage: main.py [-h] [--no-extend] [--alignment ALIGNMENT] [--out OUT] [--version] [--seed SEED] [--shuffle-paintings {vanilla,match,replace-unknown,random}] [--custom-painting-author {disable,mika}] [--shuffle-skybox] [--shuffle-entries]
+               [--shuffle-mario-outfit] [--shuffle-music] [--shuffle-objects] [--shuffle-colors] [--shuffle-text] [--shuffle-instruments] [--disable-cutscenes]
                rom
 
 positional arguments:
   rom
 
 optional arguments:
   -h, --help            show this help message and exit
-  --no-extend           disable auto-extend of ROM, which might fail on some
-                        systems
+  --no-extend           disable auto-extend of ROM, which might fail on some systems
   --alignment ALIGNMENT
-                        Specify the byte alignment. If you know this value,
-                        you have a higher change of successfully randomizing
-                        romhacks.
+                        Specify the byte alignment. If you know this value, you have a higher change of successfully randomizing romhacks.
   --out OUT             target of randomized rom
   --version             show program's version number and exit
-  --seed SEED           Allows you to play the same version as a friend,
-                        simply enter the same seed as them and you will be
-                        playing the exact same ROM.
+  --seed SEED           Allows you to play the same version as a friend, simply enter the same seed as them and you will be playing the exact same ROM.
   --shuffle-paintings {vanilla,match,replace-unknown,random}
-                        Change the behaviour of how the paintings in the
-                        castle are shuffled ("match" - matches randomized
-                        levels, i.e. painting = level, "random" -
-                        independently randomize paintings, "off" - leave
-                        paintings untouched)
+                        Change the behaviour of how the paintings in the castle are shuffled ("match" - matches randomized levels, i.e. painting = level, "random" - independently randomize paintings, "off" - leave paintings untouched)
   --custom-painting-author {disable,mika}
-                        This property allows changing the custom paintings to
-                        a different author, if you want to add your own, see
-                        the sm64.vanilla.yml
-  --shuffle-skybox      Randomizes the sky-texture between different levels.
-                        The black skybox is excluded.
-  --shuffle-entries     Shuffles the levelentries. When you enter a level, you
-                        will end up at a random one.
+                        This property allows changing the custom paintings to a different author, if you want to add your own, see the sm64.vanilla.yml
+  --shuffle-skybox      Randomizes the sky-texture between different levels. The black skybox is excluded.
+  --shuffle-entries     Shuffles the levelentries. When you enter a level, you will end up at a random one.
   --shuffle-mario-outfit
                         Randomizes parts of Marios Outfit.
   --shuffle-music       Randomizes most songs in the game.
   --shuffle-objects     Shuffles Objects in Levels
   --shuffle-colors      Shuffle various colors in the game
-  --shuffle-text        Shuffle Dialog text, for signs, npc dialog, level
-                        dialog and prompts.
-  --disable-cutscenes   Disables some of the games cutscenes. (Peach Intro,
-                        Lakitu Intro, Bowser-Text on Entry)
-  --disable-starwarp    Disables automatically leaving the level when you
-                        collect a star. This way, all stars act like a
-                        100-Coin star or a Bowser 8-Reds Star
-  --stardoor-requirements {vanilla,random,open}
-                        Changes how the doors to levels require different
-                        amounts of stars to be collected beforehand. Random
-                        means all doors require stars, but the amount will be
-                        random. Open simply means all doors are open from the
-                        start.
-  --keydoor-requirements {vanilla,open}
-                        Changes how the locked keydoors in the castle work.
-                        Vanilla means you will require the usual keys from the
-                        Bowser fights. Open means they're simply open from the
-                        start.
+  --shuffle-text        Shuffle Dialog text, for signs, npc dialog, level dialog and prompts.
   --shuffle-instruments
-                        Shuffles instrument sounds around. Many different
-                        objects and songs use different instrument sets, as
-                        the N64 can't load all at once. This will shuffle them
-                        around. Might be wacky.
+                        Shuffles instrument sounds around. Many different objects and songs use different instrument sets, as the N64 can't load all at once. This will shuffle them around. Might be wacky.
+  --disable-cutscenes   Disables some of the games cutscenes. (Peach Intro, Lakitu Intro, Bowser-Text on Entry)
 ```
 
 # Contributing: Getting Started
+
 To work on this repository, follow the following steps. Please also definitely join the [discord](https://discord.gg/2ZYfhcB) for help.
+
 1. `git clone` this repository
 2. Make sure you somehow have python >3.6 (Mac OSX I suggest `brew install`, Linux I suggest `apt install python3`, windows I suggest the installer)
 3. Create a `venv` via `python3 -m venv .` while inside the folder
 4. Install dependencies via `pip install -r requirements-dev.txt`
 
 # Special Thanks
+
 - [hack64](http://hack64.net/)'s wonderful SM64 hacking resources, clean, easy to use and great in-depth details
 - [SimpleFlips](https://www.youtube.com/user/SimpleFlips) Discord-Server for help with SM64 hacking/weirdness (especially Felegg)
 - Durkhaz for the amazing logo

__version__.py

@@ -1 +1 @@
-__version__ = '0.10.0'
+__version__ = '0.10.1'

sm64r/CLI.py

@@ -90,6 +90,7 @@ def generate_output_path(rom_in: Path):
 def run_with_parsed_args(opt_args: argparse.Namespace):
     rom_path = Path(opt_args.rom)
     out_path = opt_args.out or rom_path.with_suffix(f'.out{rom_path.suffix}')
+    start_time = time.time()
 
     if not rom_path.exists():
         raise Exception("invalid file, does not exist")
@@ -99,6 +100,7 @@ def run_with_parsed_args(opt_args: argparse.Namespace):
         opt_args.seed = randint(1e10, 10e10)
 
     with ROM(rom_path, out_path, opt_args.alignment) as rom:
+
         try:
             rom.verify_header()
         except Exception as err:
@@ -150,8 +152,6 @@ def run_with_parsed_args(opt_args: argparse.Namespace):
         # rom.match_segments(0xD78271)
         # rom.match_segments(0xA8181C) # texture for question mark
 
-        start_time = time.time()
-
         music_random = MusicRandomizer(rom)
         if opt_args.shuffle_music:
             music_random.shuffle_music(ALL_LEVELS)
@@ -199,18 +199,18 @@ def run_with_parsed_args(opt_args: argparse.Namespace):
         gameplay_stuff = Gameplay(rom)
         if opt_args.disable_cutscenes:
             gameplay_stuff.disable_all_cutscenes()
-        if opt_args.disable_starwarp:
-            gameplay_stuff.disable_starwarp()
-
-        stardoor_randomizer = StardoorRandomizer(rom)
-        if opt_args.stardoor_requirements != "vanilla":
-            if opt_args.stardoor_requirements == "open":
-                stardoor_randomizer.open_level_stardoors()
-            elif opt_args.stardoor_requirements == "random":
-                stardoor_randomizer.shuffle_level_stardoors()
-
-        if opt_args.keydoor_requirements != "vanilla":
-            stardoor_randomizer.open_keydoors()
+        # if opt_args.disable_starwarp:
+        #     gameplay_stuff.disable_starwarp()
+
+        # stardoor_randomizer = StardoorRandomizer(rom)
+        # if opt_args.stardoor_requirements != "vanilla":
+        #     if opt_args.stardoor_requirements == "open":
+        #         stardoor_randomizer.open_level_stardoors()
+        #     elif opt_args.stardoor_requirements == "random":
+        #         stardoor_randomizer.shuffle_level_stardoors()
+
+        # if opt_args.keydoor_requirements != "vanilla":
+        #     stardoor_randomizer.open_keydoors()
 
         skybox_randomizer = SkyboxRandomizer(rom)
         if opt_args.shuffle_skybox: