Docs: Clarify Documentation Information for Undertale, Terraria, DOOM 1993 (#2149)
* Cleaned up Undertale documentation Standardized file names * Outlined Terraria installation more clearly Other minor edits to setup guide * Minor edits to DOOM 1993 set-up guide * Update worlds/terraria/docs/setup_en.md Co-authored-by: kindasneaki <ryandj67@hotmail.com> * Suggested changes from @Seldom-SE Co-authored-by: Seldom <38388947+seldom-se@users.noreply.github.com> * Code block to quotation change from code review Co-authored-by: Seldom <38388947+seldom-se@users.noreply.github.com> Co-authored-by: Chris Wilson <chris@legendserver.info> * Code review from @LegendaryLinux Co-authored-by: Chris Wilson <chris@legendserver.info> --------- Co-authored-by: kindasneaki <ryandj67@hotmail.com> Co-authored-by: Seldom <38388947+seldom-se@users.noreply.github.com> Co-authored-by: Chris Wilson <chris@legendserver.info>
This commit is contained in:
Nicholas Saylor
GitHub
parent
b40fba0840
commit
db7c0c9db9
|
|
@ -11,9 +11,9 @@
|
|||
|
||||
## Installing AP Doom
|
||||
1. Download [APDOOM.zip](https://github.com/Daivuk/apdoom/releases) and extract it.
|
||||
2. Copy DOOM.WAD from your steam install into the extracted folder.
|
||||
2. Copy `DOOM.WAD` from your game's installation directory into the newly extracted folder.
|
||||
You can find the folder in steam by finding the game in your library,
|
||||
right clicking it and choosing *Manage→Browse Local Files*.
|
||||
right-clicking it and choosing **Manage -> Browse Local Files**.
|
||||
|
||||
## Joining a MultiWorld Game
|
||||
|
||||
|
|
|
|||
|
|
@ -3,11 +3,23 @@
|
|||
## Required Software
|
||||
|
||||
Download and install [Terraria](https://store.steampowered.com/app/105600/Terraria/)
|
||||
and [TModLoader](https://store.steampowered.com/app/1281930/tModLoader/) on Steam
|
||||
and [tModLoader](https://store.steampowered.com/app/1281930/tModLoader/) on Steam
|
||||
|
||||
## Installing the Archipelago Mod
|
||||
|
||||
Subscribe to [the mod](https://steamcommunity.com/sharedfiles/filedetails/?id=2922217554) on Steam.
|
||||
1. Subscribe to [the mod](https://steamcommunity.com/sharedfiles/filedetails/?id=2922217554) on Steam
|
||||
2. Open tModLoader
|
||||
3. Go to **Workshop -> Manage Mods** and enable the Archipelago mod
|
||||
- If tModLoader states that you need version 1.4.3, follow the following steps
|
||||
1. Close tModLoader
|
||||
2. Right-Click tModLoader in Steam and select **Properties**
|
||||
3. Navigate to **Betas -> Beta Participation**
|
||||
4. Select **1.4.3-legacy - Legacy - Stable tModLoader for Terraria 1.4.3**
|
||||
5. Update tModLoader through Steam
|
||||
6. Open tModLoader and navigate back to the **Manage Mods** menu
|
||||
4. tModLoader will say that it needs to refresh; exit this menu, and it will do this automatically
|
||||
5. Once tModLoader finishes loading, the Archipelago mod is finished installing; you can now
|
||||
[connect to an Archipelago game](#joining-an-archipelago-game-in-terraria).
|
||||
|
||||
This mod might not work with mods that significantly alter progression or vanilla features. It is
|
||||
highly recommended to use utility mods and features to speed up gameplay, such as:
|
||||
|
|
@ -16,7 +28,7 @@ highly recommended to use utility mods and features to speed up gameplay, such a
|
|||
- Ore Excavator
|
||||
- Magic Storage
|
||||
- Alchemist NPC Lite
|
||||
- (May be used to break progression)
|
||||
- (Can be used to break progression)
|
||||
- Reduced Grinding
|
||||
- Upgraded Research
|
||||
|
||||
|
|
@ -24,8 +36,8 @@ highly recommended to use utility mods and features to speed up gameplay, such a
|
|||
|
||||
### What is a YAML and why do I need one?
|
||||
|
||||
You can see the [basic multiworld setup guide](/tutorial/Archipelago/setup/en) here
|
||||
on the Archipelago website to learn about why Archipelago uses YAML files and what they're for.
|
||||
The [basic multiworld setup guide](/tutorial/Archipelago/setup/en) can be found on Archipelago's website. Among other things, it explains what .yaml
|
||||
files are, and how they are used.
|
||||
|
||||
### Where do I get a YAML?
|
||||
|
||||
|
|
@ -34,17 +46,15 @@ on the Archipelago website to generate a YAML using a graphical interface.
|
|||
|
||||
## Joining an Archipelago Game in Terraria
|
||||
|
||||
1. Launch TModLoader
|
||||
2. In Workshop > Manage Mods, edit Archipelago Randomizer's settings
|
||||
- "Name" should be the player name you set when creating your YAML file
|
||||
- "Port" should be the port number associated with the Archipelago server. It will be a 4 or 5
|
||||
digit number.
|
||||
- If you're not hosting your game on the Archipelago website, change "Address" to the server's
|
||||
URL or IP address
|
||||
3. Create a new character and world as normal (or use an existing one if you prefer). Terraria is
|
||||
usually significantly more difficult with this mod, so it is recommended to choose a lower
|
||||
difficulty than you normally would.
|
||||
4. Open the world in single player or multiplayer
|
||||
1. Launch tModLoader
|
||||
2. In **Workshop > Manage Mods**, edit Archipelago Randomizer's settings
|
||||
- **Name** should be the player name you set when creating your YAML file.
|
||||
- **Port** should be the port number associated with the Archipelago server. It will be a 4 or 5-digit number.
|
||||
- If you're not hosting your game on the Archipelago website, change **Address** to the server's URL or IP address
|
||||
3. Create a new character and world as normal (or use an existing one if you prefer). Terraria usually becomes
|
||||
significantly more difficult with this mod, so it is recommended to choose a lower difficulty than you normally would
|
||||
play on.
|
||||
4. Open the world in single player or multiplayer.
|
||||
5. When you're ready, open chat, and enter `/apstart` to start the game.
|
||||
|
||||
## Commands
|
||||
|
|
|
|||
|
|
@ -33,8 +33,8 @@ class UndertaleWeb(WebWorld):
|
|||
"A guide to setting up the Archipelago Undertale software on your computer. This guide covers "
|
||||
"single-player, multiworld, and related software.",
|
||||
"English",
|
||||
"undertale_en.md",
|
||||
"undertale/en",
|
||||
"setup_en.md",
|
||||
"setup/en",
|
||||
["Mewlif"]
|
||||
)]
|
||||
|
||||
|
|
|
|||
|
|
@ -24,24 +24,29 @@ every major route in the game, those being `Pacifist`, `Neutral`, and `Genocide`
|
|||
|
||||
There are some major differences between vanilla and the randomizer.
|
||||
|
||||
There are now doors to every major area in the underground located in the flower room (The first room of the game), those being Ruins, Snowdin, Waterfall, Hotland, and Core.
|
||||
There are now doors to every major area in the underground located in the flower room (the first room of the game.)
|
||||
These doors lead to Ruins, Snowdin, Waterfall, Hotland, and Core from left to right.
|
||||
Each door needs their respective key from the pool to enter.
|
||||
You start with one key for a random door. (Core will never be given to start with.)
|
||||
The rest of the keys will be in the item pool.
|
||||
You start with one key for a random door and the rest of the keys will be in the item pool to be found by other players.
|
||||
(Core will never be given to start with, unless otherwise specified.)
|
||||
|
||||
Genocide works a little differently in terms of the requirements.
|
||||
You now only need to get through Core and fight Mettaton NEO, and then beat Sans, to win.
|
||||
If you choose to fight other major bosses, you will still need to grind out the area before fighting them like normal.
|
||||
|
||||
Pacifist is mostly the same, except you are not required to go to the Ruins to spare Toriel,
|
||||
you only need to spare Papyrus, Undyne, and Mettaton EX. Although you still cannot kill anyone.
|
||||
You are also still required to do the date/hangout with Papyrus, the hangout with Undyne, and the date with Alphys,
|
||||
in that order, before entering the True Lab.
|
||||
**Genocide** works a little differently in terms of the requirements.
|
||||
|
||||
You now require custom items to Hangout with Papyrus, Undyne, to enter the True Lab, and to fight Mettaton EX/NEO.
|
||||
Those being `Complete Skeleton`, `Fish`, `DT Extractor`, and `Mettaton Plush`.
|
||||
In order to win with the genocide route, you only need to get through Core, fight Mettaton NEO, and beat Sans to win.
|
||||
If you choose to fight other major bosses, you will still need to progress the area like normal before fighting them.
|
||||
|
||||
The Riverperson will only take you to locations you have actually seen the Riverperson at.
|
||||
Meaning they will only take you to, for example, Waterfall, if you have seen the Riverperson at Waterfall at least once.
|
||||
**Pacifist** remains mostly the same.
|
||||
|
||||
In the Pacifist run, you are not required to go to the Ruins to spare Toriel. The only necessary spares are Papyrus,
|
||||
Undyne, and Mettaton EX. Just as it is in the vanilla game, you cannot kill anyone. You are also required to complete
|
||||
the date/hangout with Papyrus, Undyne, and Alphys, in that order, before entering the True Lab.
|
||||
|
||||
Additionally, custom items are required to hang out with Papyrus, Undyne, to enter the True Lab, and to fight
|
||||
Mettaton EX/NEO. The respective items for each interaction are `Complete Skeleton`, `Fish`, `DT Extractor`,
|
||||
and `Mettaton Plush`.
|
||||
|
||||
The Riverperson will only take you to locations you have seen them at, meaning they will only take you to
|
||||
Waterfall if you have seen them at Waterfall at least once.
|
||||
|
||||
If you press `W` while in the save menu, you will teleport back to the flower room, for quick access to the other areas.
|
||||
|
|
@ -0,0 +1,65 @@
|
|||
# Undertale Randomizer Setup Guide
|
||||
|
||||
### Required Software
|
||||
|
||||
- Undertale from the [Steam page](https://store.steampowered.com/app/391540)
|
||||
- Archipelago from the [Archipelago Releases Page](https://github.com/ArchipelagoMW/Archipelago/releases)
|
||||
- (select `Undertale Client` during installation.)
|
||||
|
||||
### First time setup
|
||||
|
||||
Start the Undertale client from your Archipelago folder and input `/auto_patch <Your Undertale Install Directory>` at the bottom.
|
||||
|
||||
This directory is usually located at `C:\Program Files\Steam\steamapps\Undertale`, but it can be different depending on
|
||||
your installation. You can easily find the directory by opening the Undertale directory through Steam by right-clicking
|
||||
Undertale in your library and selecting `Manage -> Browse local files`. Then, on Windows you can see the directory that
|
||||
you need at the top of the window that opens.
|
||||
|
||||
After using the `/auto_patch` command, **Archipelago will make an Undertale folder within the Archipelago install
|
||||
location.** That folder contains the version of Undertale you will use for Archipelago. (If you update Archipelago,
|
||||
you will need to redo this set-up.)
|
||||
|
||||
**Linux Users**: The Linux installation is mostly similar, however, Undertale will be installed on Steam as the Linux
|
||||
variant. Since this randomizer only supports the Windows version, we must fix this, by right-click the game in Steam,
|
||||
going to `Properties -> Compatibility`, and checking `Force the use of a specific Steam Play compatibility tool`. This
|
||||
downloads the Windows version of Undertale to use instead of the Linux version. If the play button is greyed out in
|
||||
Steam, be sure to go to `Settings -> Compatibility` and toggle `Enable Steam Play for all other titles`.
|
||||
|
||||
### Connect to the MultiServer
|
||||
|
||||
Make sure both Undertale **from the Archipelago folder** and its client are running. (Undertale will ask for a save slot
|
||||
to play on. Archipelago Undertale does not overwrite vanilla saves, but you may want to back up your save as a precaution.)
|
||||
|
||||
In the top text box of the client, type the `IP Address` (or `Hostname`) and `Port` separated with a `:` symbol.
|
||||
(Ex. `archipelago.gg:38281`)
|
||||
|
||||
The client will then ask for the slot name, input your slot name chosen during YAML creation in the text box at the
|
||||
bottom of the client.
|
||||
|
||||
**Linux Users**: When you start the client, it is likely that the save data path is incorrect, and how the game
|
||||
is played depends on where the save data folder is located.
|
||||
|
||||
**On Steam (via Proton)**: This assumes the game is in a Steam Library folder. Right-click Undertale, go to `Manage ->
|
||||
Browse Local Files`. Go up the directories to the `steamapps` folder, open `compatdata/391540` (391540 is the "magic number" for
|
||||
Undertale in Steam). Save data from here is at `/pfx/drive_c/users/steamuser/AppData/Local/UNDERTALE`.
|
||||
|
||||
**Through WINE directly**: This depends on the prefix used. If it is default, then the save data is located at
|
||||
`/home/USERNAME/.wine/drive_c/users/USERNAME/AppData/Local/UNDERTALE`.
|
||||
|
||||
Once the save data folder is located, run the `/savepath` command to redirect the client to the correct save data folder
|
||||
before connecting.
|
||||
|
||||
### Play the game
|
||||
|
||||
When the console tells you that you have joined the room, you're all set. Congratulations on successfully joining a
|
||||
multi-world game!
|
||||
|
||||
### PLEASE READ!
|
||||
|
||||
Please read this page in its entirety before asking questions! Most importantly, there is a list of
|
||||
gameplay differences at the bottom.
|
||||
[Undertale Game Info Page](/games/Undertale/info/en)
|
||||
|
||||
### Where do I get a YAML file?
|
||||
|
||||
You can customize your settings by visiting the [Undertale Player Settings Page](/games/Undertale/player-settings)
|
||||
|
|
@ -1,59 +0,0 @@
|
|||
# Undertale Randomizer Setup Guide
|
||||
|
||||
### Required Software
|
||||
|
||||
- Undertale from the [Steam page](https://store.steampowered.com/app/391540)
|
||||
- Archipelago from the [Archipelago Releases Page](https://github.com/ArchipelagoMW/Archipelago/releases)
|
||||
- (select `Undertale Client` during installation.)
|
||||
|
||||
### First time setup
|
||||
|
||||
Start the Undertale client, and in the bottom text box, input `/auto_patch (Input your Undertale install directory here)` (It is usually located at `C:\Program Files\Steam\steamapps\Undertale`, but it can be different, you can more easily find the directory
|
||||
by opening the Undertale directory through Steam), it will then make an Undertale folder that will be created in the
|
||||
Archipelago install location. That contains the version of Undertale you will use for Archipelago. (You will need to
|
||||
redo this step when updating Archipelago.)
|
||||
|
||||
**Linux Users**: This guide is mostly similar; however, when Undertale is installed on Steam, it defaults to a Linux
|
||||
supported variant; this randomizer only supports the Windows version. To fix this, right-click the game in Steam, go to
|
||||
Properties -> Compatibility, and check "Force the use of a specific Steam Play compatibility tool". This
|
||||
downloads the Windows version instead. If the play button is greyed out in Steam, be sure to go to
|
||||
Settings -> Compatibility and toggle "Enable Steam Play for all other titles".
|
||||
|
||||
### Connect to the MultiServer
|
||||
|
||||
Make sure both Undertale and its client are running. (Undertale will ask for a saveslot, it can be 1 through 99, none
|
||||
of the slots will overwrite your vanilla save, although you may want to make a backup just in case.)
|
||||
|
||||
In the top text box of the client, type the
|
||||
`Ip Address` (or `Hostname`) and `Port` separated with a `:` symbol. (Ex. `archipelago.gg:38281`)
|
||||
|
||||
The client will then ask for the slot name, input that in the text box at the bottom of the client.
|
||||
|
||||
**Linux Users**: When you start the client, it is likely that the save data path is incorrect, and how the game
|
||||
is played depends on where the save data folder is located.
|
||||
|
||||
*On Steam (via Proton)*: This assumes the game is in a Steam Library folder. Right-click Undertale, go to Manage ->
|
||||
Browse Local Files. Move back to the steamapps folder, open compatdata/391540 (391540 is the "magic number" for
|
||||
Undertale in Steam and can be confirmed by visiting its store page and looking at the URL). Save data from here is at
|
||||
/pfx/drive_c/users/steamuser/AppData/Local/UNDERTALE.
|
||||
|
||||
*Through WINE directly*: This depends on the prefix used. If it is default, then the save data is located at
|
||||
/home/USERNAME/.wine/drive_c/users/USERNAME/AppData/Local/UNDERTALE.
|
||||
|
||||
Once the save data folder is located, run the /savepath command to redirect the client to the correct save data folder
|
||||
before connecting.
|
||||
|
||||
### Play the game
|
||||
|
||||
When the console tells you that you have joined the room, you're all set. Congratulations on successfully joining a
|
||||
multiworld game!
|
||||
|
||||
### PLEASE READ!
|
||||
|
||||
Please read this page in its entirety before asking questions! Most importantly, there is a list of
|
||||
gameplay differences at the bottom.
|
||||
[Undertale Game Info Page](/games/Undertale/info/en)
|
||||
|
||||
### Where do I get a YAML file?
|
||||
|
||||
You can customize your settings by visiting the [Undertale Player Settings Page](/games/Undertale/player-settings)
|
||||
Loading…
Reference in New Issue