Documentation updates

This commit is contained in:
MarioSpore
2025-08-07 22:48:24 -04:00
parent a49921392b
commit 3b7a6554ac
3 changed files with 19 additions and 25 deletions

View File

@@ -1,3 +1,5 @@
- Credit to Raven-187 & Hacc on gamehacking.org for providing the addresses for various cheat codes. Without them, would of made RAM searching much more tedious.
- Shoutouts to SomeJakeGuy for basically teaching me how to code, in general.
- Shoutouts to BootsinSoots for helping with the implementation of the logic rules code itself
- Credit to Raven-187 & Hacc on gamehacking.org for providing the addresses for various cheat codes. Without them, this
would of made RAM searching much more tedious.
- Shoutouts to SomeJakeGuy for basically teaching me how to code in general.
- Shoutouts to BootsinSoots for helping with the implementation of the logic rules code itself.
- Thanks to the Grinch PS1 speedrunning discord community server for encouraging the production of this randomizer.

View File

@@ -5,17 +5,22 @@
The [player options page for this game](../player-options) contains all the
options you need to configure and export a config file.
## What does randomization do to this game?
## What items and locations get shuffled?
Items such as gadgets, sleigh parts, heart of stones, vacuum accesses, and useful items (or mission specific items) are
shuffled. Locations that players can do to send items out include visiting an area for the first time, collecting a blueprint,
and completing a mission.
## What is the goal of The Grinch when randomized?
The player must obtain the Skis, Twin-End Tuba, Exhaust Pipes, and the Tires to be able to build the sleigh and to finally
stop Christmas from coming once and for all by neutralizing Santa Claus!
## Which items can be in another player's world?
## When the player receives an item, what happens?
- All gadgets such as the binoculars, Rotten Egg Launcher, Rocket Spring, Slime Shooter, Octopus Climbing Device, Marine
Mobile, and the Grinch Copter.
- 4 Heart of Stones that increases the player's max health by one.
- Useful items, or mission specific items, that allow the player to access certain subareas or complete missions that
require that specific item.
- Vacuum accesses that give the player access to Who Forest, Who Dump, and Who Lake respectively.

View File

@@ -4,12 +4,9 @@
- [Archipelago](https://github.com/ArchipelagoMW/Archipelago/releases). Please use version 0.6.2 or later for integrated
BizHawk support.
- Legally obtained NTSC Bin ROM file, probably named something like `Grinch, The (USA) (En,Fr,Es).bin`.
- CUE files may work, but I have not tested this.
- [BizHawk](https://tasvideos.org/BizHawk/ReleaseHistory) Version 2.9.1 is supported, but I can't promise if any version is stable or not.
- The latest `thegrinch.apworld` file. You can find this on the [Releases page](https://github.com/MarioSpore/Grinch-AP/releases/latest). Put this in your `Archipelago/custom_worlds` folder.
## Configuring BizHawk
- The latest `grinch.apworld` file. You can find this on the [Releases page](https://github.com/MarioSpore/Grinch-AP/releases/latest). Put this in your `Archipelago/custom_worlds` folder.
## Configuring your Config (.yaml) file
@@ -30,16 +27,6 @@ so on the YAML Validator page: [YAML Validation page](/check)
## Joining a MultiWorld Game
### Obtain your patch file and create your ROM
When you join a multiworld game, you will be asked to provide your config file to whomever is
hosting. Once that is done, the host will provide you with either a link to download your patch
file, or with a zip file containing everyone's patch files. Your patch file should have a `.apgrinch`
extension.
Put your patch file on your desktop or somewhere convenient, and double click it. This should
automatically launch the client, and will also create your ROM in the same place as your patch file.
### Connect to the Multiserver
Once both the client and the emulator are started, they must be connected. **This should happen automatically.**