Skip to content

Commit a747110

Browse files
alwaysintrebleEmilyV99
authored andcommitted
The Messenger: update docs formatting and fix outdated info (ArchipelagoMW#3033)
* The Messenger: update docs formatting and fix outdated info * address review feedback * 120 chars
1 parent 40be03f commit a747110

File tree

3 files changed

+22
-23
lines changed

3 files changed

+22
-23
lines changed

worlds/messenger/docs/en_The Messenger.md

+14-15
Original file line numberDiff line numberDiff line change
@@ -49,30 +49,29 @@ for it. The groups you can use for The Messenger are:
4949
## Other changes
5050

5151
* The player can return to the Tower of Time HQ at any point by selecting the button from the options menu
52-
* This can cause issues if used at specific times. Current known:
53-
* During Boss fights
54-
* After Courage Note collection (Corrupted Future chase)
55-
* This is currently an expected action in logic. If you do need to teleport during this chase sequence, it
56-
is recommended to quit to title and reload the save
52+
* This can cause issues if used at specific times. If used in any of these known problematic areas, immediately
53+
quit to title and reload the save. The currently known areas include:
54+
* During Boss fights
55+
* After Courage Note collection (Corrupted Future chase)
5756
* After reaching ninja village a teleport option is added to the menu to reach it quickly
5857
* Toggle Windmill Shuriken button is added to option menu once the item is received
59-
* The mod option menu will also have a hint item button, as well as a release and collect button that are all placed when
60-
the player fulfills the necessary conditions.
58+
* The mod option menu will also have a hint item button, as well as a release and collect button that are all placed
59+
when the player fulfills the necessary conditions.
6160
* After running the game with the mod, a config file (APConfig.toml) will be generated in your game folder that can be
62-
used to modify certain settings such as text size and color. This can also be used to specify a player name that can't
63-
be entered in game.
61+
used to modify certain settings such as text size and color. This can also be used to specify a player name that can't
62+
be entered in game.
6463

6564
## Known issues
6665
* Ruxxtin Coffin cutscene will sometimes not play correctly, but will still reward the item
6766
* If you receive the Magic Firefly while in Quillshroom Marsh, The De-curse Queen cutscene will not play. You can exit
68-
to Searing Crags and re-enter to get it to play correctly.
69-
* Sometimes upon teleporting back to HQ, Ninja will run left and enter a different portal than the one entered by the
70-
player. This may also cause a softlock.
67+
to Searing Crags and re-enter to get it to play correctly.
68+
* Teleporting back to HQ, then returning to the same level you just left through a Portal can cause Ninja to run left
69+
and enter a different portal than the one entered by the player or lead to other incorrect inputs, causing a soft lock
7170
* Text entry menus don't accept controller input
7271
* In power seal hunt mode, the chest must be opened by entering the shop from a level. Teleporting to HQ and opening the
73-
chest will not work.
72+
chest will not work.
7473

7574
## What do I do if I have a problem?
7675

77-
If you believe something happened that isn't intended, please get the `log.txt` from the folder of your game installation
78-
and send a bug report either on GitHub or the [Archipelago Discord Server](http://archipelago.gg/discord)
76+
If you believe something happened that isn't intended, please get the `log.txt` from the folder of your game
77+
installation and send a bug report either on GitHub or the [Archipelago Discord Server](http://archipelago.gg/discord)

worlds/messenger/docs/setup_en.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -18,17 +18,17 @@ Read changes to the base game on the [Game Info Page](/games/The%20Messenger/inf
1818
3. Click on "The Messenger"
1919
4. Follow the prompts
2020

21+
These steps can also be followed to launch the game and check for mod updates after the initial setup.
22+
2123
### Manual Installation
2224

2325
1. Download and install Courier Mod Loader using the instructions on the release page
2426
* [Latest release is currently 0.7.1](https://github.com/Brokemia/Courier/releases)
2527
2. Download and install the randomizer mod
2628
1. Download the latest TheMessengerRandomizerAP.zip from
27-
[The Messenger Randomizer Mod AP releases page](https://github.com/alwaysintreble/TheMessengerRandomizerModAP/releases)
29+
[The Messenger Randomizer Mod AP releases page](https://github.com/alwaysintreble/TheMessengerRandomizerModAP/releases)
2830
2. Extract the zip file to `TheMessenger/Mods/` of your game's install location
29-
* You cannot have both the non-AP randomizer and the AP randomizer installed at the same time. The AP randomizer
30-
is backwards compatible, so the non-AP mod can be safely removed, and you can still play seeds generated from the
31-
non-AP randomizer.
31+
* You cannot have both the non-AP randomizer and the AP randomizer installed at the same time
3232
3. Optionally, Backup your save game
3333
* On Windows
3434
1. Press `Windows Key + R` to open run
@@ -46,13 +46,13 @@ Read changes to the base game on the [Game Info Page](/games/The%20Messenger/inf
4646
3. Enter connection info using the relevant option buttons
4747
* **The game is limited to alphanumerical characters, `.`, and `-`.**
4848
* This defaults to `archipelago.gg` and does not need to be manually changed if connecting to a game hosted on the
49-
website.
49+
website.
5050
* If using a name that cannot be entered in the in game menus, there is a config file (APConfig.toml) in the game
51-
directory. When using this, all connection information must be entered in the file.
51+
directory. When using this, all connection information must be entered in the file.
5252
4. Select the `Connect to Archipelago` button
5353
5. Navigate to save file selection
5454
6. Start a new game
55-
* If you're already connected, deleting a save will not disconnect you and is completely safe.
55+
* If you're already connected, deleting an existing save will not disconnect you and is completely safe.
5656

5757
## Continuing a MultiWorld Game
5858

worlds/messenger/options.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ class ShuffleTransitions(Choice):
8989

9090

9191
class Goal(Choice):
92-
"""Requirement to finish the game."""
92+
"""Requirement to finish the game. To win with the power seal hunt goal, you must enter the Music Box through the shop chest."""
9393
display_name = "Goal"
9494
option_open_music_box = 0
9595
option_power_seal_hunt = 1

0 commit comments

Comments
 (0)