Skip to content

Commit 5a659d5

Browse files
nicholassaylorBicoloursnake
authored andcommitted
Docs, Various Games: Add Unique Local Commands to Game Page (ArchipelagoMW#2285)
* Add Unique Locals Commands to ChecksFinder * Add Unique Locals Commands to MMBN3 Game Page * Add Unique Locals Commands to Ocarina of Time Game Page * Add Unique Locals Commands to Undertale Game Page * Add Unique Locals Commands to Wargroove Game Page * Add Unique Locals Commands to The Legend of Zelda Game Page * Add Unique Locals Commands to Zillion Game Page * Amend Unique Locals Commands on Final Fantasy 1 Game Page * Add Unique Locals Commands to Pokemon R/B Game Page * Grammar fix for FF1 * Corrected sections names to match * Added commands to Starcraft 2 Wings of Liberty game page Co-authored-by: Bicoloursnake <[email protected]> --------- Co-authored-by: Bicoloursnake <[email protected]>
1 parent f19c648 commit 5a659d5

File tree

10 files changed

+96
-14
lines changed

10 files changed

+96
-14
lines changed

worlds/checksfinder/docs/en_ChecksFinder.md

+10-3
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,18 @@ many checks as you have gained items, plus five to start with being available.
1414
## When the player receives an item, what happens?
1515

1616
When the player receives an item in ChecksFinder, it either can make the future boards they play be bigger in width or
17-
height, or add a new bomb to the future boards, with a limit to having up to one fifth of the _current_ board being
18-
bombs. The items you have gained _before_ the current board was made will be said at the bottom of the screen as a number
17+
height, or add a new bomb to the future boards, with a limit to having up to one fifth of the _current_ board being
18+
bombs. The items you have gained _before_ the current board was made will be said at the bottom of the screen as a
19+
number
1920
next to an icon, the number is how many you have gotten and the icon represents which item it is.
2021

2122
## What is the victory condition?
2223

2324
Victory is achieved when the player wins a board they were given after they have received all of their Map Width, Map
24-
Height, and Map Bomb items. The game will say at the bottom of the screen how many of each you have received.
25+
Height, and Map Bomb items. The game will say at the bottom of the screen how many of each you have received.
26+
27+
## Unique Local Commands
28+
29+
The following command is only available when using the ChecksFinderClient to play with Archipelago.
30+
31+
- `/resync` Manually trigger a resync.

worlds/ff1/docs/en_Final Fantasy.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ All local and remote items appear the same. Final Fantasy will say that you rece
2626
emulator will display what was found external to the in-game text box.
2727

2828
## Unique Local Commands
29-
The following command is only available when using the FF1Client for the Final Fantasy Randomizer.
29+
The following commands are only available when using the FF1Client for the Final Fantasy Randomizer.
3030

3131
- `/nes` Shows the current status of the NES connection.
32+
- `/toggle_msgs` Toggle displaying messages in EmuHawk

worlds/mmbn3/docs/en_MegaMan Battle Network 3.md

+7
Original file line numberDiff line numberDiff line change
@@ -72,3 +72,10 @@ what item and what player is receiving the item
7272

7373
Whenever you have an item pending, the next time you are not in a battle, menu, or dialog box, you will receive a
7474
message on screen notifying you of the item and sender, and the item will be added directly to your inventory.
75+
76+
## Unique Local Commands
77+
78+
The following commands are only available when using the MMBN3Client to play with Archipelago.
79+
80+
- `/gba` Check GBA Connection State
81+
- `/debug` Toggle the Debug Text overlay in ROM

worlds/oot/docs/en_Ocarina of Time.md

+7
Original file line numberDiff line numberDiff line change
@@ -31,3 +31,10 @@ Items belonging to other worlds are represented by the Zelda's Letter item.
3131

3232
When the player receives an item, Link will hold the item above his head and display it to the world. It's good for
3333
business!
34+
35+
## Unique Local Commands
36+
37+
The following commands are only available when using the OoTClient to play with Archipelago.
38+
39+
- `/n64` Check N64 Connection State
40+
- `/deathlink` Toggle deathlink from client. Overrides default setting.

worlds/pokemon_rb/docs/en_Pokemon Red and Blue.md

+6
Original file line numberDiff line numberDiff line change
@@ -80,3 +80,9 @@ All items for other games will display simply as "AP ITEM," including those for
8080
A "received item" sound effect will play. Currently, there is no in-game message informing you of what the item is.
8181
If you are in battle, have menus or text boxes opened, or scripted events are occurring, the items will not be given to
8282
you until these have ended.
83+
84+
## Unique Local Commands
85+
86+
The following command is only available when using the PokemonClient to play with Archipelago.
87+
88+
- `/gb` Check Gameboy Connection State

worlds/sc2wol/docs/en_Starcraft 2 Wings of Liberty.md

+21-1
Original file line numberDiff line numberDiff line change
@@ -31,4 +31,24 @@ The goal is to beat the final mission: 'All In'. The config file determines whic
3131

3232
By default, any of StarCraft 2's items (specified above) can be in another player's world. See the
3333
[Advanced YAML Guide](https://archipelago.gg/tutorial/Archipelago/advanced_settings/en)
34-
for more information on how to change this.
34+
for more information on how to change this.
35+
36+
## Unique Local Commands
37+
38+
The following commands are only available when using the Starcraft 2 Client to play with Archipelago.
39+
40+
- `/difficulty [difficulty]` Overrides the difficulty set for the world.
41+
- Options: casual, normal, hard, brutal
42+
- `/game_speed [game_speed]` Overrides the game speed for the world
43+
- Options: default, slower, slow, normal, fast, faster
44+
- `/color [color]` Changes your color (Currently has no effect)
45+
- Options: white, red, blue, teal, purple, yellow, orange, green, lightpink, violet, lightgrey, darkgreen, brown,
46+
lightgreen, darkgrey, pink, rainbow, random, default
47+
- `/disable_mission_check` Disables the check to see if a mission is available to play. Meant for co-op runs where one
48+
player can play the next mission in a chain the other player is doing.
49+
- `/play [mission_id]` Starts a Starcraft 2 mission based off of the mission_id provided
50+
- `/available` Get what missions are currently available to play
51+
- `/unfinished` Get what missions are currently available to play and have not had all locations checked
52+
- `/set_path [path]` Menually set the SC2 install directory (if the automatic detection fails)
53+
- `/download_data` Download the most recent release of the necassry files for playing SC2 with Archipelago. Will
54+
overwrite existing files

worlds/tloz/docs/en_The Legend of Zelda.md

+11-3
Original file line numberDiff line numberDiff line change
@@ -35,9 +35,17 @@ filler and useful items will cost less, and uncategorized items will be in the m
3535

3636
## Are there any other changes made?
3737

38-
- The map and compass for each dungeon start already acquired, and other items can be found in their place.
38+
- The map and compass for each dungeon start already acquired, and other items can be found in their place.
3939
- The Recorder will warp you between all eight levels regardless of Triforce count
40-
- It's possible for this to be your route to level 4!
40+
- It's possible for this to be your route to level 4!
4141
- Pressing Select will cycle through your inventory.
4242
- Shop purchases are tracked within sessions, indicated by the item being elevated from its normal position.
43-
- What slots from a Take Any Cave have been chosen are similarly tracked.
43+
- What slots from a Take Any Cave have been chosen are similarly tracked.
44+
-
45+
46+
## Local Unique Commands
47+
48+
The following commands are only available when using the Zelda1Client to play with Archipelago.
49+
50+
- `/nes` Check NES Connection State
51+
- `/toggle_msgs` Toggle displaying messages in EmuHawk

worlds/undertale/docs/en_Undertale.md

+15-4
Original file line numberDiff line numberDiff line change
@@ -42,11 +42,22 @@ In the Pacifist run, you are not required to go to the Ruins to spare Toriel. Th
4242
Undyne, and Mettaton EX. Just as it is in the vanilla game, you cannot kill anyone. You are also required to complete
4343
the date/hangout with Papyrus, Undyne, and Alphys, in that order, before entering the True Lab.
4444

45-
Additionally, custom items are required to hang out with Papyrus, Undyne, to enter the True Lab, and to fight
46-
Mettaton EX/NEO. The respective items for each interaction are `Complete Skeleton`, `Fish`, `DT Extractor`,
45+
Additionally, custom items are required to hang out with Papyrus, Undyne, to enter the True Lab, and to fight
46+
Mettaton EX/NEO. The respective items for each interaction are `Complete Skeleton`, `Fish`, `DT Extractor`,
4747
and `Mettaton Plush`.
4848

49-
The Riverperson will only take you to locations you have seen them at, meaning they will only take you to
49+
The Riverperson will only take you to locations you have seen them at, meaning they will only take you to
5050
Waterfall if you have seen them at Waterfall at least once.
5151

52-
If you press `W` while in the save menu, you will teleport back to the flower room, for quick access to the other areas.
52+
If you press `W` while in the save menu, you will teleport back to the flower room, for quick access to the other areas.
53+
54+
## Unique Local Commands
55+
56+
The following commands are only available when using the UndertaleClient to play with Archipelago.
57+
58+
- `/resync` Manually trigger a resync.
59+
- `/patch` Patch the game.
60+
- `/savepath` Redirect to proper save data folder. (Use before connecting!)
61+
- `/auto_patch` Patch the game automatically.
62+
- `/online` Makes you no longer able to see other Undertale players.
63+
- `/deathlink` Toggles deathlink

worlds/wargroove/docs/en_Wargroove.md

+8-1
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,16 @@ Any of the above items can be in another player's world.
2626

2727
## When the player receives an item, what happens?
2828

29-
When the player receives an item, a message will appear in Wargroove with the item name and sender name, once an action
29+
When the player receives an item, a message will appear in Wargroove with the item name and sender name, once an action
3030
is taken in game.
3131

3232
## What is the goal of this game when randomized?
3333

3434
The goal is to beat the level titled `The End` by finding the `Final Bridges`, `Final Walls`, and `Final Sickle`.
35+
36+
## Unique Local Commands
37+
38+
The following commands are only available when using the WargrooveClient to play with Archipelago.
39+
40+
- `/resync` Manually trigger a resync.
41+
- `/commander` Set the current commander to the given commander.

worlds/zillion/docs/en_Zillion.md

+9-1
Original file line numberDiff line numberDiff line change
@@ -67,8 +67,16 @@ Note that in "restrictive" mode, Champ is the only one that can get Zillion powe
6767

6868
Canisters retain their original appearance, so you won't know if an item belongs to another player until you collect it.
6969

70-
When you collect an item, you see the name of the player it goes to. You can see in the client log what item was collected.
70+
When you collect an item, you see the name of the player it goes to. You can see in the client log what item was
71+
collected.
7172

7273
## When the player receives an item, what happens?
7374

7475
The item collect sound is played. You can see in the client log what item was received.
76+
77+
## Unique Local Commands
78+
79+
The following commands are only available when using the ZillionClient to play with Archipelago.
80+
81+
- `/sms` Tell the client that Zillion is running in RetroArch.
82+
- `/map` Toggle view of the map tracker.

0 commit comments

Comments
 (0)