Merge pull request #56 from Catobat/0.7-dev

Minish Cap Randomizer 0.7 Dev Rev 3 (RC 2)

.gitignore

@@ -33,11 +33,20 @@ bld/
 [Ll]og/
 [Ll]ogs/
 
+# Files generated by the Randomizer
+log.json
+Minish Randomizer-*-ROM.gba
+Minish Randomizer-*-Patch.bps
+Minish Randomizer-*-Spoiler.txt
+
 # Visual Studio 2015/2017 cache/options directory
 .vs/
 # Uncomment if you have tasks that create the project's static files in wwwroot
 #wwwroot/
 
+# Visual Studio Code options directory
+.vscode/
+
 # Visual Studio 2017 auto generated files
 Generated\ Files/
 

Build Tools/Build Releases.ps1

@@ -14,4 +14,4 @@ dotnet publish .\MinishCapRandomizerCLI.csproj -c Release -o $outputPath\CLI\lin
 dotnet publish .\MinishCapRandomizerCLI.csproj -c Release -o $outputPath\CLI\linux-arm\ -r linux-arm
 cd '..\Build Tools\' 
 Write-Host "Done Building!" -foregroundcolor Green
-Pause
+pause

Changelog.md

@@ -0,0 +1,161 @@
+#### This is a pre-release version
+
+## What's New!
+
+---
+
+### Settings
+
+The last remaining issues with the parser and shuffler have been resolved and any settings that went missing in the previous build now return! This also includes the return of location reachability (revision 2 only supported the option where any unrequired items could be locked).
+
+It also means that we can focus more on adding entirely new options. There is no shortage of new and exciting options, please take a look and give them a try!
+
+#### New Settings
+
+- Requirement Reward: Can enable a new item location, the item of which is given to the player once they meet the selected requirements (elements, sword, dungeons and figurines).
+	- Disabled: This location doesn’t exist.
+	- DHC Big Key: The DHC Big Key is instantly awarded to the player once they meet the selected requirements.
+	- Random Item: An item from the random item pool is instantly awarded to the player once they meet the selected requirements.
+- Cucco Minigame: Determine how many out of the 10 rounds have a random item. The remaining rounds are skipped (by default, only one round is playable, so the first 9 are skipped). You can even disable it entirely (you can still play round 10 for the rupees, but not for an item).
+- Goron Merchant: Choose how many sets of Goron Merchant items are included in the random item pool. Each set consists of 3 items, and all 3 must be bought to advance to the next set. There are 5 sets in total. The remaining sets will be filled with junk items. Note that the Goron Merchant is only available if Blue Fusions aren’t removed.
+- Seeded Shared Fusions: This setting affects Red, Blue and Green Fusions if set to Vanilla or Combined. There is a Pool of 18 Shared Fusions in the Game: 16 Green, 1 Blue and 1 Red. These Fusions are randomly selected by an NPC who offers Shared Fusions when you enter the room they are in. If this setting is enabled then the seed generates a listed order these NPCs offer the Fusions in. This makes different people playing the same seed have the same Fusions available which is useful for races.
+- Hyrule Town Wind Crest: Previously this used to be always activated from the start. This is no longer the case (unless Homewarp is disabled), now it can be toggled.
+- Dungeon Warps: The 12 blue and red dungeon warps can now individually be opened from the start.
+- Location Reachability: This setting determines which items and locations are guaranteed to be reachable. There are now 3 options:
+	- All Locations: All enabled locations (depending on other settings) are reachable.
+    - All NonKeys: Like All Locations, except keys can lock themselves.
+    - Only the Goal: Only the goal is guaranteed to be reachable. Some locations and items may be inaccessible. If the DHC setting is set to “Never Open”, then the goal is the pedestal requirements, otherwise the goal is Defeat Vaati.
+- Grab items from a distance: If enabled, items can be collected from a distance with either Gust Jar, Boomerang, or even a Sword Slash. There are 4 options:
+	- Not Allowed: Items cannot be grabbed from a distance (except rupees and certain junk).
+    - Allowed: Items can be grabbed from a distance, but this will never be required by logic.
+    - Require: Items can be grabbed from a distance and logic can require grabbing them when they are obviously grabbable.
+    - Require Hard: Items can be grabbed from a distance, and logic can require some very difficult Boomerang throws to be able to collect these items. Many of these involve throwing the Boomerang in an arc behind or to the side of the items before making Link run in the opposite direction to get the Boomerang to grab the item on the return journey to Link.
+- Bows: New option Yes + Bosses: Only if this is enabled, bows can be solely required to defeat Gleerok and Mazaal.
+- Goron Merchant JP/US prices: If enabled will use the prices found in the JP and US versions for the Goron Merchant items. The tooltip shows all the prices for all regions.
+- Low Health Beep: The number of frames between the low health beeps. One second is 60, vanilla value is 90, max 255.
+
+#### Returning Settings
+
+- Figurine Hunt: Figurines are added to the item pool and are required to activate the Sanctuary. The amount of Figurines in the pool and the amount needed for the Sanctuary can be chosen.
+- Random Bottle Contents: Bottles will start out filled with various different contents, see if you can find the butter.
+
+#### Now Optional instead of Always On
+
+- Instant Text
+- Boots on L (in a dropdown with “Minish Dash”)
+- Ocarina on Select (now also works if “Prevent Speedrun Glitches” is off)
+- Disable Random Kinstone Drops
+- Disable Random Shell Drops
+
+### Improvements to the Previous Build
+
+#### UI Changes
+
+- Window scaling above 100% is improved, but there’s still room for improvement in the future. Let us know if you encounter any issues!
+- Custom logic files can be used again! Go to the “Advanced” tab, enable “Use Custom Logic File”, and select the file.
+- Custom patch files can be used again! Go to the “Advanced” tab, enable “Use Custom Patch Files”, and select the file.
+- The UI is slightly smaller now to support smaller screens.
+- Numberbox settings have up and down buttons in the UI, and their value can also be adjusted using arrow keys.
+
+#### CLI Changes
+
+- First of all, the CLI is working again!
+- File output was broken if no output path was specified, this is now fixed.
+- There are no more “Press enter to continue…” or confirmation messages.
+- The “Exit” command works in more situations.
+- When listing the settings, the currently selected option is now shown at the end of each line.
+- To choose an option to change, you can also enter the name of the option instead of the listed number.
+- Flag options can also be disabled by entering “0”.
+- There’s a new “Strict” mode that makes it so the CLI exits when an error occurs.
+- Command files can now be provided.
+
+#### Shuffler Changes
+
+- Dropdown settings can now have any of their options set as the default option. For example in the default logic, dungeon items now default to “Own Dungeon” like in previous builds.
+- Numberbox settings can have a min and a max value set.
+- The DungeonMinor item type returns to greatly improve seed generation rates. This type places these items in Dungeon locations just like DungeonMajor, but only after all DungeonMajor items are placed.
+- The shuffler will now always attempt to make all “Minor” items (usually including Bottles, Pieces of Heart and Butterflies) reachable (assuming Reachability isn’t set to “Always the Goal” in the default logic file). This can fail if there are not enough locations available, most notably if Gold Fusions are Removed or if a lot of Figurines are included.
+- Most items with subtypes now have names instead of numbers in the spoiler (Affects Keys, Maps, Compasses, Bottles and Traps. Figurines are still a WIP).
+- Seeds now generate much faster (around 10% as long) due to better caching.
+
+#### Patch Changes
+
+- Shopkeepers mention Kinstone shapes and colors.
+- Ocarina Menu change: If you select a Wind Crest and then "No", instead of exiting the menu, you can select another one (like in non-EU versions).
+- With Shuffled Dungeon Entrances, elements are displayed on the map screen that actually contains that dungeon instead of the screen that contains that dungeon in vanilla.
+- The North Hyrule Field bridge softlock prevention is now removed when Homewarp is enabled.
+- When Hyrule Town is entered from Trilby Highlands, the soldier stops blocking that path even if you don’t have the items that normally move him. (This can matter with Open Wind Crests.)
+- When the Roc’s Cape is obtained in Hyrule Town, you no longer have to screen transition before you can get the item from the bell.
+
+#### Logic Changes
+
+- Shop money logic is more flexible.
+- Small Keys can now lock themselves in DHC_2F_BlueWarp_BigChest (if “Reachability” is set to “All NonKeys”).
+
+#### Bug Fixes since rev2.1
+
+- In Non-Progressive items: Red/Blue/Four Swords can now activate the 2nd Town Dojo items, and the last 3 items can be received in any order.
+- Dungeon Entrance Shuffle no longer causes Link to have weird facing angles when going through transitions.
+- Fixed digging spots sometimes having major items when digging spot shuffle is turned off.
+- Fixed Golden Enemy items sometimes not dropping (for example if it holds 5 bombs, but the player has no Bomb Bag), making it impossible to permanently kill the enemy.
+- Dampé can now always be encountered in this house, allowing to fuse with him even when he’s waiting for you to have the Graveyard Key stolen.
+- Shared Fusions can now properly be Removed.
+- If Green Fusions are Removed and Red Fusions Vanilla or Combined, Tingle’s remaining Fusion still requires the Magic Boomerang.
+- A few issues with Pedestal requirements have been fixed, which could occur if no sword or element requirements were set. It’s also possible to have no requirements now.
+- Golden Enemies and some Rupee spots used to be shuffled when not supposed to.
+- Goron Merchant is now tied to the correct Kinstone color (blue) and spawns under the right circumstances.
+- Fixed a logic bug with Upper Crenel.
+- In Combined Gold Fusions, the Veil Falls Gold Fusion now logically requires all 9 Golden Kinstones if the Veil Falls or Cloud Tops Wind Crest is activated.
+- Fixed some issues with Fortress of Winds with Open World or Barren.
+- Barren and Unrequired Dungeons work correctly now.
+- Fixes Shared Fusions logic not taking other Kinstones into account.
+- The Reduced Item Pool used to contain 3 Bows by accident.
+- The Shuffler didn’t verify the CRC of the selected ROM.
+- The stone block at the Castor Wilds statues is now also visually destroyed with Open Gold Fusions.
+- Item Name Display was buggy when Figurine Hunt was enabled.
+- The “Skip Fusion Cutscene” options are now correctly applied.
+- Fixed an issue with Ankle (Tingle’s brother on Lon Lon Ranch) that caused him to glitch out. This was also responsible for the flashing clouds on this screen. (This only took 3.5 years to fix!)
+- Dungeon requirements are now actually enforced in the game.
+- Homewarping no longer messes up the credits statistics and clone count.
+- The roll count in the end credits is now accurate.
+- Imported functions are now cleared between generating seeds.
+- Fixed inaccuracies with vanilla Red Kinstone Piece locations.
+- Fixed various logic issues in Open World.
+- Fixed an issue when generating seeds with Vanilla Big Keys.
+
+### Miscellaneous
+
+#### Updates Planned for Future Builds
+
+- Further improve UI scaling.
+- Have localization options in the UI.
+- Display seed hashes in UI and CLI.
+- Starting equipment options.
+- Completely decouple Open World setting into smaller settings.
+- YAML file support for saving and sharing custom presets and Mystery weights.
+- Custom item placements and item pool adjustments.
+- Allow logic files to be split into multiple files.
+- Logic for glitches and Firerod.
+- Fix the known issues.
+
+#### Known Issues
+
+- When the Graveyard Key is knocked out of your hands, it looks like the progressive sword.
+- Electric Chu’s have buggy animations.
+- Regional Keys combined with Dungeon Entrance Shuffle is unintuitive, eg: If Fortress is shuffled to Crenel, Small Keys for Fortress can be found in Wind Ruins but not in Crenel.
+- Major items sometimes do not show up properly in the Playthrough section of the spoiler log if they have a Minor version of the same item, or if they are unshuffled. (This has a pending fix in a later version)
+- About and Changelog pages are not implemented yet.
+- Verbose logger causes massive explosions in log size and has been disabled while we work on a fix.
+- Getting a second bomb bag with remotes equipped sometimes changes it back to regular bombs.
+- Followers cause a fair amount of visual bugs ranging from miss coloured palettes, to certain sprites being completely missing.
+- The Clouds in Palace of Winds sometimes are invisible but function normally, leaving and re-entering the room they are in can make them visible again.
+
+### Useful Resources
+
+- EmoTracker download - https://emotracker.net/download/
+  - Get Deoxis' tracker on EmoTracker, it has support for the newest settings. No other trackers are updated with the newest features.
+- BizHawk download - https://tasvideos.org/Bizhawk/ReleaseHistory#Bizhawk242
+  - Required prerequisites - https://github.com/TASEmulators/BizHawk-Prereqs/releases
+- mGBA download - https://mgba.io/downloads.html
+
+

MinishCapRandomizerCLI/CommandFileParser.cs

@@ -0,0 +1,88 @@
+namespace MinishCapRandomizerCLI;
+
+public static class CommandFileParser
+{
+    internal static void ParseCommandsFile(string filename)
+    {
+        var file = new StreamReader(new FileStream(filename, FileMode.Open));
+        var exited = false;
+        while (!file.EndOfStream && !exited)
+        {
+            var input = file.ReadLine();
+
+            var inputs = input.Split(' ');
+
+            switch (inputs[0])
+            {
+                case "LoadRom":
+                    GenericCommands.LoadRom(inputs[1]);
+                    break;
+                case "ChangeSeed":
+                    GenericCommands.Seed(inputs[1], inputs.Length > 2 ? inputs[2] : null);
+                    break;
+                case "LoadLogic":
+                    GenericCommands.LoadLogic(inputs.Length > 1 ? inputs[1] : "");
+                    break;
+                case "LoadPatch":
+                    GenericCommands.LoadPatch(inputs.Length > 1 ? inputs[1] : "");
+                    break;
+                case "LoadSettings":
+                    GenericCommands.LoadSettings(inputs[1]);
+                    break;
+                case "Logging":
+                    GenericCommands.Logging(inputs[1], inputs.Length > 2 ? inputs[2] : null, inputs.Length > 2 ? inputs[2] : null);
+                    break;
+                case "Randomize":
+                    GenericCommands.Randomize(inputs[1]);
+                    break;
+                case "SaveRom":
+                    GenericCommands.SaveRom(inputs[1]);
+                    break;
+                case "SaveSpoiler":
+                    GenericCommands.SaveSpoiler(inputs[1]);
+                    break;
+                case "SavePatch":
+                    GenericCommands.SavePatch(inputs[1]);
+                    break;
+                case "GetSettingString":
+                    GenericCommands.GetSettingString();
+                    break;
+                case "Rem":
+                    Console.WriteLine($"Commented out line {input}");
+                    break;
+                case "BulkGenerateSeeds":
+                    if (!int.TryParse(inputs[1], out var numberOfSeedToGen))
+                        throw new Exception("Provided value of bulk generated seeds is not a number!");
+
+                    var num = 0;
+                    var failures = 0;
+                    while (num++ < numberOfSeedToGen)
+                    {
+                        GenericCommands.Seed("R");
+                        var result = GenericCommands.Randomize("1");
+                        if (!result)
+                        {
+                            --num;
+                            ++failures;
+                        }
+                        else
+                            Console.WriteLine($"Generated seed {num}");
+                    }
+                    Console.WriteLine($"Total failure rate: {(double)failures/num}%");
+                    break;
+                case "Exit":
+                    exited = true;
+                    break;
+                default:
+                    Console.WriteLine($"Warning: Invalid command or whitespace line {input} detected! Parsing will continue.");
+                    break;
+            }
+
+        }
+
+        if (!exited)
+        {
+            Console.WriteLine("Warning: End of command file reached but no call to Exit was read! This will exit as expected, but all command files should include an exit call at the end in the event this changes going forward.");
+        }
+    }
+}