Grinch-AP/worlds/messenger/docs/setup_en.md

# The Messenger Randomizer Setup Guide

## Quick Links
- [Main Page](../../../../games/The%20Messenger/info/en)
- [Settings Page](../../../../games/The%20Messenger/player-settings)
- [Courier Github](https://github.com/Brokemia/Courier)
- [The Messenger Randomizer Github](https://github.com/minous27/TheMessengerRandomizerMod)
- [Jacksonbird8237's Item Tracker](https://github.com/Jacksonbird8237/TheMessengerItemTracker)
- [PopTracker Pack](https://github.com/alwaysintreble/TheMessengerTrackPack)

## Required Software

- [The Messenger](https://store.steampowered.com/app/764790/The_Messenger/)
  - Only Steam version is currently supported.
- [Courier Mod Loader](https://github.com/Brokemia/Courier/releases)
- [The Messenger Randomizer Mod](https://github.com/minous27/TheMessengerRandomizerMod/releases)

## Installation

1. Download and install Courier Mod Loader using the instructions on the release page
2. Download and install the randomizer mod
     * Download the latest `TheMessengerRandomizer.zip`
     * Extract the zip file to `TheMessenger/Mods/` of your game's install location
     * Optionally, Backup your save game
       1. Press `Windows Key + R` to open run
       2. Type `%appdata%` to access AppData
       3. Navigate to `AppData/locallow/SabotageStudios/The Messenger`
       4. Rename `SaveGame.txt` to any name of your choice

## Joining a MultiWorld Game

1. Launch the game
2. Navigate to `Options > Third Party Mod Options`
3. Select `Reset Randomizer File Slots`
   * This will set up all of your save slots with new randomizer save files. You can have up to 3 randomizer files at a
time, but must do this step again to start new runs afterwards.
4. Enter connection info using the relevant option buttons
   * **The game is limited to alphanumerical characters and `-` so when entering the host name replace `.` with ` ` and
ensure that your player name when generating a settings file follows these constrictions**
   * This defaults to `archipelago.gg` and does not need to be manually changed if connecting to a game hosted on the
website.
5. Select the `Connect to Archipelago` button
6. Navigate to save file selection
7. Select a new valid randomizer save

## Troubleshooting

If you launch the game, and it hangs on the splash screen for more than 30 seconds try these steps:
1. Close the game and remove `TheMessengerRandomizer` from the `Mods` folder.
2. Launch The Messenger
3. Delete any save slot
4. Reinstall the randomizer mod following step 2 of the installation.
The Messenger: implement new game (#1494) * initial commit of messenger integration * setup no_logic and needed slot_data * fix some typos and determinism * make all of it deterministic * add documentation * swapped to non local items so change the fed data * ~~deathlink~~ * satisfy the docs test * update doc test to show expected name * split custom classes into a separate file and fix an errant rule * make access dependency test give more useful errors * implement tests * remove some unneccessary back entrances and make names clearer * fix some big dumbs * successful unit tests are good also some slight reorganizing * add astral tea quest line, and potentially power seals as items * if TYPE_CHECKING... aahhhhhh * oop forgot to remove legacy code * having the seed and leaves as actual items doesn't seem to do anything so remove them. locations still work though * update setup guide with some changes * Tower HQ was creating duplicate locations * allow self locking items * cleanup * move self_locking_items function to core * docstring * implement choice of notes needed for music box * test the default value * don't create any starting inventory items * make item creation faster * change default accessibility and power seals options * improve documentation * precollected_items is a dict of Items... * implement shop chest goal * tests * always assign total and required seals * add new goals and set music box as requiring shop chest on shop chest goals instead of just setting it as the completion * fix dumb test quirk * implement music box skip as an option * world rewrite/cleanup * default to apworld and add game to readme * revert bleeding commits from other PRs * more bleeds * fix some errors in options docstrings * ??? * make my set rules method not have an awful name * test cleanup * add a test for item accessibility * fix issues with tests * make the self locking item behavior work correctly * misc cleanup * more general cleanup to be a good example * quick rules rewrite * more general cleanup and typing * more speed, more clean * bump data version * make sure the locked item belongs to current player * fix bad name and indent. call MessengerItem directly for events * add poptracker pack to docs * doc cleanup and "known issues" section that I probably won't be able to fix any time soon. * missed some spots * add another bug i forgot about * be consistently wrong 2023-03-12 09:05:50 -05:00			`# The Messenger Randomizer Setup Guide`

			`## Quick Links`
			`- [Main Page](../../../../games/The%20Messenger/info/en)`
			`- [Settings Page](../../../../games/The%20Messenger/player-settings)`
			`- [Courier Github](https://github.com/Brokemia/Courier)`
			`- [The Messenger Randomizer Github](https://github.com/minous27/TheMessengerRandomizerMod)`
			`- [Jacksonbird8237's Item Tracker](https://github.com/Jacksonbird8237/TheMessengerItemTracker)`
			`- [PopTracker Pack](https://github.com/alwaysintreble/TheMessengerTrackPack)`

			`## Required Software`

			`- [The Messenger](https://store.steampowered.com/app/764790/The_Messenger/)`
			`- Only Steam version is currently supported.`
			`- [Courier Mod Loader](https://github.com/Brokemia/Courier/releases)`
			`- [The Messenger Randomizer Mod](https://github.com/minous27/TheMessengerRandomizerMod/releases)`

			`## Installation`

			`1. Download and install Courier Mod Loader using the instructions on the release page`
			`2. Download and install the randomizer mod`
			* Download the latest `TheMessengerRandomizer.zip`
			* Extract the zip file to `TheMessenger/Mods/` of your game's install location
			`* Optionally, Backup your save game`
			1. Press `Windows Key + R` to open run
			2. Type `%appdata%` to access AppData
			3. Navigate to `AppData/locallow/SabotageStudios/The Messenger`
			4. Rename `SaveGame.txt` to any name of your choice

			`## Joining a MultiWorld Game`

			`1. Launch the game`
			2. Navigate to `Options > Third Party Mod Options`
			3. Select `Reset Randomizer File Slots`
			`* This will set up all of your save slots with new randomizer save files. You can have up to 3 randomizer files at a`
			`time, but must do this step again to start new runs afterwards.`
			`4. Enter connection info using the relevant option buttons`
			* **The game is limited to alphanumerical characters and `-` so when entering the host name replace `.` with ` ` and
			`ensure that your player name when generating a settings file follows these constrictions**`
			* This defaults to `archipelago.gg` and does not need to be manually changed if connecting to a game hosted on the
			`website.`
			5. Select the `Connect to Archipelago` button
			`6. Navigate to save file selection`
			`7. Select a new valid randomizer save`

			`## Troubleshooting`

			`If you launch the game, and it hangs on the splash screen for more than 30 seconds try these steps:`
			1. Close the game and remove `TheMessengerRandomizer` from the `Mods` folder.
			`2. Launch The Messenger`
			`3. Delete any save slot`
			`4. Reinstall the randomizer mod following step 2 of the installation.`