Skip to content

Commit

Permalink
StarCraft 2 macOS documentation (ArchipelagoMW#1747)
Browse files Browse the repository at this point in the history
* Adding SC2 macOS instructions

A few hours ago, I tested whether the client would run successfully on macOS (Send/Receive items, load maps, download maps, etc.). After the successful testing, I thought adding some documentation would be nice for those who want to play Archipelago on a macOS system.

* Don't need sudo

Turns out you don't need sudo to do the download_data, oops.

* Removed Extraneous Parantheses
  • Loading branch information
Bicoloursnake authored Apr 24, 2023
1 parent dcc628f commit c0cf35e
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions worlds/sc2wol/docs/setup_en.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ to obtain a config file for StarCraft 2.
- Linux users should also follow the instructions found at the bottom of this page
(["Running in Linux"](#running-in-linux)).
2. Run ArchipelagoStarcraft2Client.exe.
- macOS users should instead follow the instructions found at ["Running in macOS"](#running-in-macos) for this step only.
3. Type the command `/download_data`. This will automatically install the Maps and Data files from the third link above.

## Where do I get a config file (aka "YAML") for this game?
Expand All @@ -34,6 +35,7 @@ Check out [Creating a YAML](https://archipelago.gg/tutorial/Archipelago/setup/en
## How do I join a MultiWorld game?

1. Run ArchipelagoStarcraft2Client.exe.
- macOS users should instead follow the instructions found at ["Running in macOS"](#running-in-macos) for this step only.
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,
Expand All @@ -45,6 +47,10 @@ First, check the log file for issues (stored at `[Archipelago Directory]/logs/SC
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.

## Running in macOS

To run StarCraft 2 through Archipelago in macOS, you will need to run the client via source as seen here: [macOS Guide](https://archipelago.gg/tutorial/Archipelago/mac/en). Note: when running the client, you will need to run the command `python3 Starcraft2Client.py`. This is done to make sure that `/download_data` works correctly.

## 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
Expand Down

0 comments on commit c0cf35e

Please sign in to comment.