Merge branch 'release/2.2.1'

Author: BashPrime

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "metroid-prime-randomizer",
-  "version": "2.2.0",
+  "version": "2.2.1",
   "description": "Metroid Prime Randomizer",
   "homepage": "https://github.com/etaylor8086/metroid-prime-randomizer",
   "contributors": [

package.json

@@ -26,6 +26,7 @@ export class GenerateGameComponent implements OnInit {
   private userPresets: PresetObject;
   private form: FormGroup;
   private ngUnsubscribe: Subject<any> = new Subject();
+  private lastUpdatedPreset: string;
 
   // Constants
   private readonly CUSTOM_PRESET = 'Custom';
@@ -69,6 +70,28 @@ export class GenerateGameComponent implements OnInit {
           this.loaded = true;
         }
       });
+
+    this.presetsService._previousAction
+    .pipe(takeUntil(this.ngUnsubscribe))
+    .subscribe(previousAction => {
+      switch (previousAction) {
+        case 'update':
+          if (this.lastUpdatedPreset) {
+            this.setPreset(this.lastUpdatedPreset);
+            this.lastUpdatedPreset = null;
+          }
+          break;
+        case 'remove':
+          this.setPreset(this.randomizerService.DEFAULT_PRESET);
+          break;
+      }
+    });
+
+    this.presetsService._lastUpdatedPreset
+    .pipe(takeUntil(this.ngUnsubscribe))
+    .subscribe(preset => {
+      this.lastUpdatedPreset = preset;
+    });
   }
 
   ngOnDestroy() {
@@ -188,7 +211,6 @@ export class GenerateGameComponent implements OnInit {
 
   removePreset(name: string): void {
     this.presetsService.removePreset(name);
-    this.form.patchValue({ preset: this.randomizerService.DEFAULT_PRESET });
   }
 
   generateSeed(spoiler: boolean) {
@@ -217,15 +239,5 @@ export class GenerateGameComponent implements OnInit {
         this.presets[key] = preset[key];
       }
     }
-
-    // After building presets, if we imported a preset, select it in the form
-    this.presetsService._importedPreset
-      .pipe(take(1))
-      .subscribe(preset => {
-        if (preset) {
-          this.setPreset(preset);
-          this.presetsService.clearImportPresetSubject();
-        }
-      });
   }
 }

src/client/src/app/generate-game/generate-game.component.ts

@@ -17,6 +17,7 @@ export class HelpComponent implements OnInit {
   readonly menuItems = [
     { name: 'Getting Started', file: 'assets/help-documents/gettingStarted.md' },
     { name: 'FAQ', file: 'assets/help-documents/faq.md' },
+    { name: 'Softlocks', file: 'assets/help-documents/softlocks.md' },
     { name: 'Differences', file: 'assets/help-documents/differences.md' },
     { name: 'Trackers', file: 'assets/help-documents/trackers.md' }
   ];

src/client/src/app/help/help.component.ts

@@ -10,13 +10,14 @@ import { RandomizerForm } from '../../../../common/models/randomizerForm';
   providedIn: 'root'
 })
 export class PresetsService {
-  private cachedImportedPreset: string;
   private defaultPresets$ = new BehaviorSubject<PresetObject>(undefined);
   private userPresets$ = new BehaviorSubject<PresetObject>(undefined);
-  private importedPreset$ = new BehaviorSubject<string>(undefined);
+  private previousAction$ = new BehaviorSubject<string>(undefined);
+  private lastUpdatedPreset$ = new BehaviorSubject<string>(undefined);
   _defaultPresets = this.defaultPresets$.asObservable();
   _userPresets = this.userPresets$.asObservable();
-  _importedPreset = this.importedPreset$.asObservable();
+  _previousAction = this.previousAction$.asObservable();
+  _lastUpdatedPreset = this.lastUpdatedPreset$.asObservable();
 
   constructor(private ngZone: NgZone, private electronService: ElectronService, private toastrService: ToastrService) {
     this.getAllPresets();
@@ -27,33 +28,28 @@ export class PresetsService {
       });
     });
 
-    this.electronService.ipcRenderer.on('getUserPresetsResponse', (event, response: PresetsResponse) => {
+    this.electronService.ipcRenderer.on('getUserPresetsResponse', (event, response: PresetsResponse, previousAction: string) => {
       this.ngZone.run(() => {
-        // Emit imported preset key if one is provided
-        if (this.cachedImportedPreset) {
-          this.importedPreset$.next(this.cachedImportedPreset);
-          this.cachedImportedPreset = null;
-        }
-
         this.handlePresetsResponse(response, this.userPresets$);
+        this.previousAction$.next(previousAction);
       });
     });
 
     this.electronService.ipcRenderer.on('updateUserPresetResponse', (event, response) => {
       this.ngZone.run(() => {
-        this.getUserPresets();
+        this.getUserPresets('update');
       });
     });
 
     this.electronService.ipcRenderer.on('removeUserPresetResponse', (event, response) => {
       this.ngZone.run(() => {
-        this.getUserPresets();
+        this.getUserPresets('remove');
       });
     });
 
     this.electronService.ipcRenderer.on('importPresetResponse', (event, key: string, preset: RandomizerForm) => {
       this.ngZone.run(() => {
-        this.cachedImportedPreset = key;
+        this.lastUpdatedPreset$.next(key);
         this.electronService.ipcRenderer.send('updateUserPreset', preset, key);
       });
     });
@@ -79,8 +75,8 @@ export class PresetsService {
     this.electronService.ipcRenderer.send('getDefaultPresets');
   }
 
-  getUserPresets() {
-    this.electronService.ipcRenderer.send('getUserPresets');
+  getUserPresets(previousAction?: string) {
+    this.electronService.ipcRenderer.send('getUserPresets', previousAction);
   }
 
   getAllPresets() {
@@ -89,6 +85,7 @@ export class PresetsService {
   }
 
   addOrUpdatePreset(name: string, preset: RandomizerForm) {
+    this.lastUpdatedPreset$.next(name);
     this.electronService.ipcRenderer.send('updateUserPreset', preset, name);
   }
 
@@ -122,10 +119,6 @@ export class PresetsService {
     });
   }
 
-  clearImportPresetSubject(): void {
-    this.importedPreset$.next(null);
-  }
-
   private handlePresetsResponse(response: PresetsResponse, subject: Subject<PresetObject>): void {
     // If presets and keys are defined, return the original order the presets were in, otherwise don't do anything
     if (!response.presets) {

src/client/src/app/services/presets.service.ts

@@ -10,7 +10,7 @@ Every time you play a randomizer seed, you should always start from a brand-new
 
 ## My seed is broken. Items are missing, artifacts aren't working, I'm starting out with items, etc.
 
-The randomizer doesn't work (or work *well*) with pre-existing saves. You need to start from a brand-new save slot each time you play a randomizer seed or else you might run into this issue.
+The randomizer doesn't work (or work *well*) with pre-existing save slots. You need to start from a brand-new save slot each time you play a randomizer seed or else you might run into this issue.
 
 ## The game crashes if I lay a Morph Ball Bomb while submerged in water or lava.
 
@@ -30,10 +30,6 @@ This is a variation of the above problem, except the game doesn't crash. Try run
 
 You need the Charge Beam equipped in order to use beam combos.
 
-## The big red flower isn't there when I enter Sunchamber (Flaahgra's room).
-
-This happens when you enter Sunchamber from the Sun Tower side without fighting Flaahgra first. If you have Space Jump Boots, you can slope jump from one of the roots to reach the item that spawns after the Chozo Ghost fight, otherwise you won't be able to load the Flaahgra fight. If you don't have Space Jump Boots, or Flaahgra blocks access to them, you are softlocked and need to restart.
-
 ## I can't hurt Omega Pirate.
 
 Omega Pirate can only be hurt while you have the X-Ray Visor active. If you start the boss fight and don't have the X-Ray Visor, you will softlock.
@@ -48,6 +44,14 @@ You killed the two Space Pirates that normally jump down from the ledge near the
 
 Make sure you trigger the door lock first before killing the space pirates.
 
-## Why is Varia Suit in Phendrana Drifts? I don't have heat protection to get there!
+## Why is Varia Suit in Phendrana Drifts? I don't have heat protection to get there.
 
 The second half of Magmoor Caverns (past Twin Fires Tunnel) is not superheated, so the logic is likely expecting you to go to the Phendrana Quarantine Cave elevator by going to Magmoor Workstation from Phazon Mines.
+
+## When Samus morphs, her Morph Ball form looks different than her suit.
+
+Metroid Prime does not contain any 3D models or assets for Power Suit Spider Ball, Gravity Suit spiderless Morph Ball, and Phazon Suit spiderless Morph Ball, so it does the following:
+
+If Samus has the Power Suit and the Spider Ball, the game uses the Gravity Suit Spider Ball model when she is morphed.
+
+If Samus has the Gravity Suit or Phazon Suit but does not have Spider Ball, the game uses the Power Suit Morph Ball model when she is morphed.

src/client/src/assets/help-documents/faq.md

@@ -0,0 +1,55 @@
+# Softlocks
+
+Softlocks are situations where the game is usually still playable, but further progression is impossible.
+
+If you're not careful, you can accidentally find yourself in a room without the item needed to leave it, causing you to softlock. While the randomizer handles a lot of these cases, there are some that it does not and cannot account for.
+
+## Ruined Shrine
+
+If you fall into the pit in Ruined Shrine, you will need either the Morph Ball or Space Jump Boots to escape. If you get stuck, you can slope jump and abuse the standable terrain on the large vine near where the Beetle Battle item is, then dash across to the half pipe, but this is never expected of players.
+
+## Burn Dome
+
+If you do not have bombs, the Morph Ball tunnel leading to Burn Dome is a one-way trip. You will be stuck and softlocked if you do not find bombs there.
+
+## Chapel of the Elders, Antechamber, and Plasma Processing
+
+These rooms use different door colors to enter and leave them, so you can get stuck if you enter the room without having the necessary beam to open the door from the inside.
+
+## Warrior Shrine Tunnel
+
+If you enter the tunnel underneath Warrior Shrine without having bombs, you will get stuck.
+
+## Shore Tunnel
+
+If you do not have Space Jump Boots, you will either need to double bomb jump or perform a precise slope jump to reach the broken tube from the pit underneath.
+
+## Phendrana Canyon
+
+If you do not have Boost Ball or Space Jump Boots after entering the room, you will need to jump on the crates to leave. If the crates are destroyed, you will get stuck.
+
+## Observatory
+
+The bottom door only locks when you get near it. If you enter Observatory from the top door and kill the Space Pirates before triggering the lock, it will stay locked while you are still in the room. If you cannot complete the puzzle to extend the platforms, or know how to climb the room with dashes, you will softlock.
+
+Make sure you trigger the door lock first, then kill the Space Pirates.
+
+## Control Tower
+
+If you collapse the tower and enter the section where the item is without bombs, you will be unable to escape in a glitchless setting.
+
+## Quarantine Cave
+
+You can get stuck in Quarantine Cave if you do not have Spider Ball, Grapple Beam, or know how to slope jump to escape the room.
+
+## Lower Phazon Mines / Ventilation Shaft
+
+If you fall down into the half pipe section of Ventilation Shaft, you will either need Boost Ball to leave the way you entered, or the minimum items needed to traverse through lower Phazon Mines, defeat Omega Pirate, and reach Phazon Processing Center through Processing Center Access. If you cannot do either of these, you will be stuck.
+
+## Elite Quarters
+
+If you start the Omega Pirate fight and don't have X-Ray Visor, you will softlock. Omega Pirate can only take damage while you have X-Ray Visor equipped, and the room will only unlock after defeating it.
+
+## Metroid Prime Lair
+
+You can only use the Phazon Beam if you have the Phazon Suit, and Metroid Prime Essence can only take damage from the Phazon Beam. If you start the fight without the Phazon Suit, you will be unable to continue.

src/client/src/assets/help-documents/softlocks.md

@@ -31,7 +31,7 @@ export function initialize() {
     event.sender.send('getDefaultPresetsResponse', response);
   });
 
-  ipcMain.on('getUserPresets', (event) => {
+  ipcMain.on('getUserPresets', (event, previousAction: string) => {
     const userPresetsResponse = 'getUserPresetsResponse';
 
     fs.access(userPresetsPath, fs.constants.R_OK, (err) => {
@@ -45,7 +45,7 @@ export function initialize() {
         readUserPresetsFile(response => {
           // Add to allPresets object
           Object.assign(allPresets, response.presets);
-          event.sender.send(userPresetsResponse, response);
+          event.sender.send(userPresetsResponse, response, previousAction);
         });
       }
     });

src/electron/controllers/presetsController.ts

@@ -28,6 +28,11 @@
   "Beginner Friendly": {
 		"excludeLocations": [],
 		"itemOverrides": [
+			{
+				"count": 1,
+				"name": "Charge Beam",
+				"state": "starting-item"
+			},
 			{
 				"count": 1,
 				"name": "Morph Ball",
@@ -40,7 +45,12 @@
 			},
 			{
 				"count": 1,
-				"name": "Charge Beam",
+				"name": "Boost Ball",
+				"state": "starting-item"
+			},
+			{
+				"count": 1,
+				"name": "Spider Ball",
 				"state": "starting-item"
 			}
 		],

src/electron/data/presetsDefault.json

@@ -3,34 +3,35 @@ import { PrimeWorld } from './world';
 import { Item } from '../item';
 import { ItemPriority } from './items';
 import { Location } from '../location';
+import { PrimeItemCollection } from './itemCollection';
 
 /**
  * Parent function for distributing an item pool across the Metroid Prime world.
  * @param world The Metroid Prime world instance being used.
  */
 export function distributeItemsRestrictive(world: PrimeWorld): void {
-    // Get whole item pool, and shuffle it
-    const itemPool = world.getItemPool().shuffle(world.getRng());
+  // Get whole item pool, and shuffle it
+  const itemPool = world.getItemPool().shuffle(world.getRng());
 
-    // Get unfilled item locations
-    let fillLocations = world.getLocations().filter((location: Location) => !location.hasItem());
+  // Get unfilled item locations
+  let fillLocations = world.getLocations().filter((location: Location) => !location.hasItem());
 
-    const progressionItemPool = itemPool.filter((item: Item) => item.getPriority() === ItemPriority.PROGRESSION);
-    const artifactsItemPool = itemPool.filter((item: Item) => item.getPriority() === ItemPriority.ARTIFACTS);
-    const extrasItemPool = itemPool.filter((item: Item) => item.getPriority() === ItemPriority.EXTRA);
+  const progressionItemPool = itemPool.filter((item: Item) => item.getPriority() === ItemPriority.PROGRESSION);
+  const artifactsItemPool = itemPool.filter((item: Item) => item.getPriority() === ItemPriority.ARTIFACTS);
+  const extrasItemPool = itemPool.filter((item: Item) => item.getPriority() === ItemPriority.EXTRA);
 
-    // Logically fill progressive items to ensure the game can be completed.
-    fillRestrictive(world, fillLocations, progressionItemPool);
+  // Logically fill progressive items to ensure the game can be completed.
+  fillRestrictive(world, fillLocations, progressionItemPool);
 
-    // Filter out filled locations
-    fillLocations = world.getLocations().filter((location: Location) => !location.hasItem());
+  // Filter out filled locations
+  fillLocations = world.getLocations().filter((location: Location) => !location.hasItem());
 
-    // Progression items are filled, artifacts can be filled fast among non-excluded locations
-    fillFast(world, fillLocations, artifactsItemPool);
+  // Progression items are filled, fill artifacts restrictively to ensure reachability
+  fillRestrictive(world, fillLocations, artifactsItemPool);
 
-    // Filter out filled locations
-    fillLocations = world.getLocations().filter((location: Location) => !location.hasItem());
+  // Filter out filled locations
+  fillLocations = world.getLocations().filter((location: Location) => !location.hasItem());
 
-    // Fill extras/remaining junk items last. No logic needed as the progression items are placed by now.
-    fillFast(world, fillLocations, extrasItemPool, true);
+  // Fill extras/remaining junk items last. No logic needed as the progression items are placed by now.
+  fillFast(world, fillLocations, extrasItemPool, true);
 }

src/electron/models/prime/fill.ts

@@ -114,7 +114,7 @@ export function chozoRuins(): RegionObject[] {
       name: 'Ruined Shrine (Outer)',
       locations: {
         [PrimeLocation.RUINED_SHRINE_HALF_PIPE]: (items: PrimeItemCollection, settings: PrimeRandomizerSettings) => {
-          const spaceJumpReqs = settings.tricks.upperRuinedShrineTowerOfLightFewerAccessReqs && items.has(PrimeItem.SPACE_JUMP_BOOTS);
+          const spaceJumpReqs = settings.tricks.upperRuinedShrineTowerOfLightFewerAccessReqs && items.has(PrimeItem.SPACE_JUMP_BOOTS) && items.has(PrimeItem.MORPH_BALL);
           return spaceJumpReqs || items.canBoost();
         }
       },

src/electron/models/prime/regions/chozoRuins.ts

@@ -285,8 +285,12 @@ export function phendranaDrifts(): RegionObject[] {
       name: 'Phendrana\'s Edge',
       locations: {
         [PrimeLocation.STORAGE_CAVE]: (items: PrimeItemCollection, settings: PrimeRandomizerSettings) => {
-          const grappleReqs = settings.tricks.removePhendranaDepthsGrappleReqs || items.has(PrimeItem.GRAPPLE_BEAM);
-          return items.canLayPowerBombs() && grappleReqs && items.has(PrimeItem.PLASMA_BEAM)
+          const grappleReqs = items.has(PrimeItem.GRAPPLE_BEAM) || settings.tricks.removePhendranaDepthsGrappleReqs;
+          // Effectively removes visor requirements if either Remove Thermal or Remove X-Ray Requirements are enabled.
+          const visorReqs = (items.has(PrimeItem.THERMAL_VISOR) || settings.tricks.removeThermalReqs)
+            || (items.has(PrimeItem.XRAY_VISOR) || settings.tricks.removeXrayReqs);
+
+          return grappleReqs && visorReqs && items.canLayPowerBombs() && items.has(PrimeItem.PLASMA_BEAM)
             && items.has(PrimeItem.SPACE_JUMP_BOOTS);
         },
         [PrimeLocation.SECURITY_CAVE]: (items: PrimeItemCollection, settings: PrimeRandomizerSettings) => {