From c61f77029b4e13993c2688299db4f443057f73d5 Mon Sep 17 00:00:00 2001 From: SoldierofOrder <107806872+SoldierofOrder@users.noreply.github.com> Date: Tue, 26 Jul 2022 10:53:30 -0400 Subject: [PATCH] SC2 docs: Extensive reworks and rewordings. (#809) --- .../docs/en_Starcraft 2 Wings of Liberty.md | 47 +++++----- worlds/sc2wol/docs/setup_en.md | 94 ++++++++++--------- 2 files changed, 74 insertions(+), 67 deletions(-) diff --git a/worlds/sc2wol/docs/en_Starcraft 2 Wings of Liberty.md b/worlds/sc2wol/docs/en_Starcraft 2 Wings of Liberty.md index aba882c7..8fa20c86 100644 --- a/worlds/sc2wol/docs/en_Starcraft 2 Wings of Liberty.md +++ b/worlds/sc2wol/docs/en_Starcraft 2 Wings of Liberty.md @@ -1,37 +1,34 @@ # Starcraft 2 Wings of Liberty -## Where is the settings page? - -The [player settings page for this game](../player-settings) contains all the options you need to configure and export a -config file. - ## What does randomization do to this game? -Items which the player would normally acquire throughout the game have been moved around. Logic remains, so the game is -always able to be completed. Options exist to also shuffle around the mission order of the campaign. +The following unlocks are randomized as items: +1. Your ability to build any non-worker unit (including Marines!). +2. Your ability to upgrade infantry weapons, infantry armor, vehicle weapons, etc. +3. All armory upgrades +4. All laboratory upgrades +5. All mercenaries +6. Small boosts to your starting mineral and vespene gas totals on each mission -## What is the goal of Starcraft 2 when randomized? +You find items by making progress in bonus objectives (like by rescuing allies in 'Zero Hour') and by completing +missions. When you receive items, they will immediately become available, even during a mission, and you will be +notified via a text box in the top-right corner of the game screen. (The text client for StarCraft 2 also records all +items in all worlds.) -The goal remains unchanged. Beat the final mission All In. +Missions are launched only through the text client. The Hyperion is never visited. Aditionally, credits are not used. -## What items and locations get shuffled? +## What is the goal of this game when randomized? -Unit unlocks, upgrade unlocks, armory upgrades, laboratory researches, and mercenary unlocks can be shuffled, and all -bonus objectives, side missions, mission completions are now locations that can contain these items. +The goal is to beat the final mission: 'All In'. The config file determines which variant you must complete. -## What has been changed from vanilla Starcraft 2? +## What non-randomized changes are there from vanilla Starcraft 2? -Some missions have been given more vespene gas available to mine to allow for a wider variety of unit compositions on -those missions. Starports no longer require Factories in order to be built. In 'A Sinister Turn' and 'Echoes -of the Future', you can research protoss air armor and weapon upgrades. +1. Some missions have more vespene geysers available to allow a wider variety of units. +2. Starports no longer require Factories in order to be built. +3. In 'A Sinister Turn' and 'Echoes of the Future', you can research Protoss air weapon/armor upgrades. -## Which items can be in another player's world? - -Any of the items which can be shuffled may also be placed into another player's world. It is possible to choose to limit -certain items to your own world. - -## When the player receives an item, what happens? - -When the player receives an item, they will receive a message through their text client and in game if currently playing - a mission. They will immediately be able to use that unlock/upgrade. +## Which of my items can be in another player's world? +By default, any of StarCraft 2's items (specified above) can be in another player's world. See the +[Advanced YAML Guide](https://archipelago.gg/tutorial/Archipelago/advanced_settings/en) +for more information on how to change this. \ No newline at end of file diff --git a/worlds/sc2wol/docs/setup_en.md b/worlds/sc2wol/docs/setup_en.md index 6697277d..1539a212 100644 --- a/worlds/sc2wol/docs/setup_en.md +++ b/worlds/sc2wol/docs/setup_en.md @@ -1,62 +1,69 @@ -# Starcraft 2 Wings of Liberty Randomizer Setup Guide +# StarCraft 2 Wings of Liberty Randomizer Setup Guide + +This guide contains instructions on how to install and troubleshoot the StarCraft 2 Archipelago client, as well as where +to obtain a config file for StarCraft 2. ## Required Software -- [Starcraft 2](https://starcraft2.com/en-us/) -- [Starcraft 2 AP Client](https://github.com/ArchipelagoMW/Archipelago) -- [Starcraft 2 AP Maps and Data](https://github.com/TheCondor07/Starcraft2ArchipelagoData) +- [StarCraft 2](https://starcraft2.com/en-us/) +- [The most recent Archipelago release](https://github.com/ArchipelagoMW/Archipelago/releases) +- [StarCraft 2 AP Maps and Data](https://github.com/TheCondor07/Starcraft2ArchipelagoData) -## General Concept +## How do I install this randomizer? -Starcraft 2 AP Client launches a custom version of Starcraft 2 running modified Wings of Liberty campaign maps - to allow for randomization of the items +1. Install StarCraft 2 and Archipelago using the first two links above. (The StarCraft 2 client for Archipelago is + included by default.) +2. Click the third link above and follow the instructions there. +3. Linux users should also follow the instructions found at the bottom of this page + (["Running in Linux"](#running-in-linux)). -## Installation Procedures +## Where do I get a config file (aka "YAML") for this game? -Follow the installation directions at the -[Starcraft 2 AP Maps and Data](https://github.com/TheCondor07/Starcraft2ArchipelagoData) page you can find the .zip -files on the releases page. After it is installed, just run ArchipelagoStarcraft2Client.exe to start the client and connect -to a Multiworld Game. +The [Player Settings](https://archipelago.gg/games/Starcraft%202%20Wings%20of%20Liberty/player-settings) page on this +website allows you to choose your personal settings for the randomizer and download them into a config file. Remember +the name you type in the `Player Name` box; that's the "slot name" the client will ask you for when you attempt to +connect! -## Joining a MultiWorld Game +### And why do I need a config file? + +Config files tell Archipelago how you'd like your game to be randomized, even if you're only using default settings. +When you're setting up a multiworld, every world needs its own config file. +Check out [Creating a YAML](https://archipelago.gg/tutorial/Archipelago/setup/en#creating-a-yaml) for more information. + +## How do I join a MultiWorld game? 1. Run ArchipelagoStarcraft2Client.exe. -2. Type in `/connect [server ip]`. -3. Insert slot name and password as prompted. -4. Once connected, use `/unfinished` to find what missions you can play and `/play [mission id]` to launch a mission. - For new games under default settings the first mission available will always be Liberation Day[1] playable using the - command `/play 1`. +2. Type `/connect [server ip]`. +3. Type your slot name and the server's password when prompted. +4. Once connected, switch to the 'StarCraft 2 Launcher' tab in the client. There, you can see every mission. By default, + only 'Liberation Day' will be available at the beginning. Just click on a mission to start it! -## Where do I get a config file? +## The game isn't launching when I try to start a mission. -The [Player Settings](/games/Starcraft%202%20Wings%20of%20Liberty/player-settings) page on the website allows you to -configure your personal settings and export them into a config file. +First, check the log file for issues (stored at `[Archipelago Directory]/logs/SC2Client.txt`). If the below fix doesn't +work for you, and you can't figure out the log file, visit our [Discord's](https://discord.com/invite/8Z65BR2) +tech-support channel for help. Please include a specific description of what's going wrong and attach your log file to +your message. -## Game isn't launching when I type /play +### Check your installation -First check the log file for issues (stored at [Archipelago Directory]/logs/SC2Client.txt. There is sometimes an issue -where the client can not find Starcraft 2. Usually 'Documents/StarCraft II/ExecuteInfo.txt' is checked to find where -Starcraft 2 is installed. On some computers particularly if you have OneDrive running this may fail. The following -directions may help you in this case if you are on Windows. - -1. Navigate to '%userprofile%'. Easiest way to do this is to hit Windows key+R type in `%userprofile%` and hit run or -type in `%userprofile%` in the navigation bar of your file explorer. -2. If it does not exist create a folder in her named 'Documents'. -3. Locate your 'My Documents' folder on your PC. If you navigate to 'My PC' on the sidebar of file explorer should be a -link to this folder there labeled 'Documents'. -4. Find a folder labeled 'StarCraft II' and copy it. -5. Paste this 'StarCraft II' folder into the folder created or found in step 2. - -These steps have been shown to work for some people for some people having issues with launching the game. If you are -still having issues check out our [Discord](https://discord.com/invite/8Z65BR2) for help. +Make sure you've followed the installation instructions completely. Specifically, make sure that you've placed the Maps +and Mods folders directly inside the StarCraft II installation folder. They should be in the same location as the +SC2Data, Support, Support64, and Versions folders. ## Running in Linux -To run StarCraft 2 through Archipelago in Linux, you will need to install the game using Wine then run the Linux build of the Archipelago client. +To run StarCraft 2 through Archipelago in Linux, you will need to install the game using Wine, then run the Linux build +of the Archipelago client. -Make sure you have StarCraft 2 installed using Wine and you have followed the [Installation Procedures](#installation-procedures) to add the Archipelago maps to the correct location. You will not need to copy the .dll files. If you're having trouble installing or running StarCraft 2 on Linux, I recommend using the Lutris installer. +Make sure you have StarCraft 2 installed using Wine, and that you have followed the +[installation procedures](#how-do-i-install-this-randomizer?) to add the Archipelago maps to the correct location. You will not +need to copy the .dll files. If you're having trouble installing or running StarCraft 2 on Linux, I recommend using the +Lutris installer. -Copy the following into a .sh file, replacing the values of **WINE** and **SC2PATH** variables to the relevant locations, as well as setting **PATH_TO_ARCHIPELAGO** to the directory containing the AppImage if it is not in the same folder as the script. +Copy the following into a .sh file, replacing the values of **WINE** and **SC2PATH** variables with the relevant +locations, as well as setting **PATH_TO_ARCHIPELAGO** to the directory containing the AppImage if it is not in the same +folder as the script. ```sh # Let the client know we're running SC2 in Wine @@ -81,8 +88,11 @@ ARCHIPELAGO="$(ls ${PATH_TO_ARCHIPELAGO:-$(dirname $0)}/Archipelago_*.AppImage | $ARCHIPELAGO Starcraft2Client ``` -For Lutris installs, you can run `lutris -l` to get the numerical ID of your StarCraft II install, then run the command below, replacing **${ID}** with the numerical ID. +For Lutris installs, you can run `lutris -l` to get the numerical ID of your StarCraft II install, then run the command +below, replacing **${ID}** with the numerical ID. lutris lutris:rungameid/${ID} --output-script sc2.sh -This will get all of the relevant environment variables Lutris sets to run StarCraft 2 in a script, including the path to the Wine binary that Lutris uses. You can then remove the line that runs the Battle.Net launcher and copy the code above into the existing script. +This will get all of the relevant environment variables Lutris sets to run StarCraft 2 in a script, including the path +to the Wine binary that Lutris uses. You can then remove the line that runs the Battle.Net launcher and copy the code +above into the existing script.