Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

The Messenger: update docs formatting and fix outdated info #3033

Merged
merged 3 commits into from
Mar 31, 2024
Merged

The Messenger: update docs formatting and fix outdated info #3033

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f0d2607
The Messenger: update docs formatting and fix outdated info
alwaysintreble Mar 26, 2024
a868a83
address review feedback
alwaysintreble Mar 28, 2024
a7f69cc
120 chars
alwaysintreble Mar 31, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 12 additions & 12 deletions worlds/messenger/docs/en_The Messenger.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,28 +49,28 @@ for it. The groups you can use for The Messenger are:
## Other changes

* The player can return to the Tower of Time HQ at any point by selecting the button from the options menu
* This can cause issues if used at specific times. Current known:
* During Boss fights
* After Courage Note collection (Corrupted Future chase)
* This is currently an expected action in logic. If you do need to teleport during this chase sequence, it
is recommended to quit to title and reload the save
* This can cause issues if used at specific times. Current known:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* This can cause issues if used at specific times. Current known:
* This can cause issues if used at specific times. Currently known areas:

Mirroring the other comment on this line, is mainly just an odd wording in my opinion
Not a vital change though

* During Boss fights
* After Courage Note collection (Corrupted Future chase)
* This is currently an expected action in logic. If you do need to teleport during this chase sequence, it
is recommended to quit to title and reload the save
* After reaching ninja village a teleport option is added to the menu to reach it quickly
* Toggle Windmill Shuriken button is added to option menu once the item is received
* The mod option menu will also have a hint item button, as well as a release and collect button that are all placed when
the player fulfills the necessary conditions.
the player fulfills the necessary conditions.
* After running the game with the mod, a config file (APConfig.toml) will be generated in your game folder that can be
used to modify certain settings such as text size and color. This can also be used to specify a player name that can't
be entered in game.
used to modify certain settings such as text size and color. This can also be used to specify a player name that can't
be entered in game.

## Known issues
* Ruxxtin Coffin cutscene will sometimes not play correctly, but will still reward the item
* If you receive the Magic Firefly while in Quillshroom Marsh, The De-curse Queen cutscene will not play. You can exit
to Searing Crags and re-enter to get it to play correctly.
* Sometimes upon teleporting back to HQ, Ninja will run left and enter a different portal than the one entered by the
player. This may also cause a softlock.
to Searing Crags and re-enter to get it to play correctly.
* Teleporting back to HQ, then returning to the same level you just left through a Portal can cause Ninja to run left
and enter a different portal than the one entered by the player or other incorrect inputs, causing a soft lock
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A verb is probably needed here. Both "lead to" and "perform" seem fine to me, there's a few options.

Suggested change
and enter a different portal than the one entered by the player or other incorrect inputs, causing a soft lock
and enter a different portal than the one entered by the player or lead to other incorrect inputs, causing a soft lock

* Text entry menus don't accept controller input
* In power seal hunt mode, the chest must be opened by entering the shop from a level. Teleporting to HQ and opening the
chest will not work.
chest will not work.

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

Expand Down
14 changes: 7 additions & 7 deletions worlds/messenger/docs/setup_en.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,17 +18,17 @@ Read changes to the base game on the [Game Info Page](/games/The%20Messenger/inf
3. Click on "The Messenger"
4. Follow the prompts

These steps can be followed in the future to launch the game and check for mod updates.

### Manual Installation

1. Download and install Courier Mod Loader using the instructions on the release page
* [Latest release is currently 0.7.1](https://github.com/Brokemia/Courier/releases)
2. Download and install the randomizer mod
1. Download the latest TheMessengerRandomizerAP.zip from
[The Messenger Randomizer Mod AP releases page](https://github.com/alwaysintreble/TheMessengerRandomizerModAP/releases)
[The Messenger Randomizer Mod AP releases page](https://github.com/alwaysintreble/TheMessengerRandomizerModAP/releases)
2. Extract the zip file to `TheMessenger/Mods/` of your game's install location
* You cannot have both the non-AP randomizer and the AP randomizer installed at the same time. The AP randomizer
is backwards compatible, so the non-AP mod can be safely removed, and you can still play seeds generated from the
non-AP randomizer.
* You cannot have both the non-AP randomizer and the AP randomizer installed at the same time
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just to make sure, part about backwards compatibility was removed voluntary? You do not want to provide further information about how one can ping-pong between the two?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In this instance, it seems to be expected that the player is here for Archipelago, possibly coming from the standalone. However, AP supports a single-world randomizer so seems redundant to talk about the standalone unless there was a difference in features.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This version of the randomizer functionally replaces the old one at this point. There was still a bit of utility in playing the standalone back when this was written, since with the AP randomizer you always had to connect to a server to play, but this is no longer the case.

3. Optionally, Backup your save game
* On Windows
1. Press `Windows Key + R` to open run
Expand All @@ -46,13 +46,13 @@ Read changes to the base game on the [Game Info Page](/games/The%20Messenger/inf
3. Enter connection info using the relevant option buttons
* **The game is limited to alphanumerical characters, `.`, and `-`.**
* This defaults to `archipelago.gg` and does not need to be manually changed if connecting to a game hosted on the
website.
website.
* If using a name that cannot be entered in the in game menus, there is a config file (APConfig.toml) in the game
directory. When using this, all connection information must be entered in the file.
directory. When using this, all connection information must be entered in the file.
4. Select the `Connect to Archipelago` button
5. Navigate to save file selection
6. Start a new game
* If you're already connected, deleting a save will not disconnect you and is completely safe.
* If you're already connected, deleting an existing save will not disconnect you and is completely safe.

## Continuing a MultiWorld Game

Expand Down
2 changes: 1 addition & 1 deletion worlds/messenger/options.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ class ShuffleTransitions(Choice):


class Goal(Choice):
"""Requirement to finish the game."""
"""Requirement to finish the game. To win power seal hunt you enter the Music Box through the shop chest."""
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Up to you whether you want "power seal hunt" or "Power Seal Hunt", but I think these words can help a bit

Suggested change
"""Requirement to finish the game. To win power seal hunt you enter the Music Box through the shop chest."""
"""Requirement to finish the game. To win with power seal hunt, you must enter the Music Box through the shop chest."""

display_name = "Goal"
option_open_music_box = 0
option_power_seal_hunt = 1
Expand Down
Loading