Skip to content

Commit efd5004

Browse files
authored
Docs: Update SA2B Linux and Steam Deck Setup Guide + Add Celeste 64 Linux Setup Guide (ArchipelagoMW#4593)
* Update Linux and Steam Deck setup guide for sa2b * Add Linux and Steam Deck setup guide for Celeste 64
1 parent c799531 commit efd5004

File tree

2 files changed

+22
-22
lines changed

2 files changed

+22
-22
lines changed

worlds/celeste64/docs/guide_en.md

+6-2
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,12 @@
1212

1313
1. Download the above release and extract it.
1414

15+
## Installation Procedures (Linux and Steam Deck)
16+
17+
1. Download the above release and extract it.
18+
19+
2. Add Celeste64.exe to Steam as a Non-Steam Game. In the properties for it on Steam, set it to use Proton as the compatibility tool. Launch the game through Steam in order to run it.
20+
1521
## Joining a MultiWorld Game
1622

1723
1. Before launching the game, edit the `AP.json` file in the root of the Celeste 64 install.
@@ -33,5 +39,3 @@ An Example `AP.json` file:
3339
"Password": ""
3440
}
3541
```
36-
37-

worlds/sa2b/docs/setup_en.md

+16-20
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
- Sonic Adventure 2: Battle from: [Sonic Adventure 2: Battle Steam Store Page](https://store.steampowered.com/app/213610/Sonic_Adventure_2/)
66
- The Battle DLC is required if you choose to add Chao Karate locations to the randomizer
77
- SA Mod Manager from: [SA Mod Manager GitHub Releases Page](https://github.com/X-Hax/SA-Mod-Manager/releases)
8-
- .NET Desktop Runtime 7.0 from: [.NET Desktop Runtime 7.0 Download Page](https://dotnet.microsoft.com/en-us/download/dotnet/thank-you/runtime-desktop-7.0.9-windows-x64-installer)
8+
- .NET Desktop Runtime 8.0 from: [.NET Desktop Runtime 8.0 Download Page](https://dotnet.microsoft.com/en-us/download/dotnet/thank-you/runtime-desktop-8.0.12-windows-x64-installer)
99
- Archipelago Mod for Sonic Adventure 2: Battle
1010
from: [Sonic Adventure 2: Battle Archipelago Randomizer Mod Releases Page](https://github.com/PoryGone/SA2B_Archipelago/releases/)
1111

@@ -36,27 +36,23 @@
3636

3737
1. Install Sonic Adventure 2: Battle from Steam.
3838

39-
2. In the properties for Sonic Adventure 2 on Steam, force the use of Proton Experimental as the compatibility tool.
40-
41-
3. Launch the game at least once without mods.
42-
43-
4. Create both a `/mods` directory and a `/SAManager` directory in the folder into which you installed Sonic Adventure 2: Battle.
39+
2. Launch the game at least once without mods.
4440

45-
5. Install SA Mod Manager as per [its instructions](https://github.com/X-Hax/SA-Mod-Manager/tree/master?tab=readme-ov-file). Specifically, extract SAModManager.exe file to the folder that Sonic Adventure 2: Battle is installed to. To launch it, add ``SAModManager.exe`` as a non-Steam game. In the properties on Steam for SA Mod Manager, set it to use Proton as the compatibility tool.
41+
3. Create both a `/mods` directory and a `/SAManager` directory in the folder into which you installed Sonic Adventure 2: Battle.
4642

47-
6. Run SAModManager.exe from Steam once. It should produce an error popup for a missing dependency, close the error.
43+
4. Unpack the Archipelago Mod into this folder, so that `/mods/SA2B_Archipelago` is a valid path.
4844

49-
7. Install protontricks, on the Steam Deck this can be done via the Discover store, on other distros instructions vary, [see its github page](https://github.com/Matoking/protontricks).
45+
5. In the SA2B_Archipelago folder, copy the `APCpp.dll` file and paste it in the Sonic Adventure 2 install folder (where `sonic2app.exe` is).
5046

51-
8. Download the [.NET 7 Desktop Runtime for x64 Windows](https://dotnet.microsoft.com/en-us/download/dotnet/thank-you/runtime-desktop-7.0.17-windows-x64-installer). If this link does not work, the download can be found on [this page](https://dotnet.microsoft.com/en-us/download/dotnet/7.0).
47+
6. Install SA Mod Manager as per [its instructions](https://github.com/X-Hax/SA-Mod-Manager/tree/master?tab=readme-ov-file). Specifically, extract SAModManager.exe file to the folder that Sonic Adventure 2: Battle is installed to. To launch it, add ``SAModManager.exe`` as a non-Steam game. In the properties on Steam for SA Mod Manager, set it to use Proton as the compatibility tool.
5248

53-
9. Right click the .NET 7 Desktop Runtime exe, and assuming protontricks was installed correctly, the option to "Open with Protontricks Launcher" should be available. Click that, and in the popup window that opens, select SAModManager.exe. Follow the prompts after this to install the .NET 7 Desktop Runtime for SAModManager. Once it is done, you should be able to successfully launch SAModManager to steam.
49+
7. Run SAModManager.exe from Steam once. It should produce an error popup saying you need .NET Desktop Runtime and ask you if you'd like to download it. Say yes and it will download through your browser.
5450

55-
6. Unpack the Archipelago Mod into this folder, so that `/mods/SA2B_Archipelago` is a valid path.
51+
8. Install protontricks, on the Steam Deck this can be done via the Discover store, on other distros instructions vary, [see its github page](https://github.com/Matoking/protontricks).
5652

57-
7. In the SA2B_Archipelago folder, copy the `APCpp.dll` file and paste it in the Sonic Adventure 2 install folder (where `sonic2app.exe` is).
53+
9. Right click the .NET Desktop Runtime exe that was downloaded in step 6, and assuming protontricks was installed correctly, the option to "Open with Protontricks Launcher" should be available. Click that, and in the popup window that opens, select SAModManager.exe. Follow the prompts after this to install the .NET Desktop Runtime for SAModManager. Once it is done, you should be able to successfully launch SAModManager to steam.
5854

59-
8. Launch `SAModManager.exe` from Steam and make sure the SA2B_Archipelago mod is listed and enabled.
55+
10. Launch `SAModManager.exe` from Steam and make sure the SA2B_Archipelago mod is listed and enabled.
6056

6157
Note: Ensure that you launch Sonic Adventure 2 from Steam directly on Linux, rather than launching using the `Save & Play` button in SA Mod Manager.
6258

@@ -77,7 +73,7 @@ Note: Ensure that you launch Sonic Adventure 2 from Steam directly on Linux, rat
7773
## Additional Options
7874

7975
Some additional settings related to the Archipelago messages in game can be adjusted in the SAModManager if you select `Configure Mod` on the SA2B_Archipelago mod. This settings will be under a `General Settings` tab.
80-
76+
8177
- Message Display Count: This is the maximum number of Archipelago messages that can be displayed on screen at any given time.
8278
- Message Display Duration: This dictates how long Archipelago messages are displayed on screen (in seconds).
8379
- Message Font Size: The is the size of the font used to display the messages from Archipelago.
@@ -94,7 +90,7 @@ If you wish to use the `SADX Music` option of the Randomizer, you must own a cop
9490

9591
- "The following mods didn't load correctly: SA2B_Archipelago: DLL error - The specified module could not be found."
9692
- Make sure the `APCpp.dll` is in the same folder as the `sonic2app.exe`. (See Installation Procedures step 6)
97-
93+
9894
- "sonic2app.exe - Entry Point Not Found"
9995
- Make sure the `APCpp.dll` is up to date. Follow Installation Procedures step 6 to update the dll.
10096

@@ -116,7 +112,7 @@ If you wish to use the `SADX Music` option of the Randomizer, you must own a cop
116112
1. Run the Launcher.exe which should be in the same folder as the your Sonic Adventure 2: Battle install.
117113
2. Select the `Player` tab and reselect the controller for the player 1 input method.
118114
3. Click the `Save settings and launch SONIC ADVENTURE 2` button. (Any mod manager settings will apply even if the game is launched this way rather than through the mod manager)
119-
115+
120116
- Game crashes after display logos.
121117
- This may be caused by a high monitor refresh rate.
122118
- Change the monitor refresh rate to 60 Hz [Change display refresh rate on Windows] (https://support.microsoft.com/en-us/windows/change-your-display-refresh-rate-in-windows-c8ea729e-0678-015c-c415-f806f04aae5a)
@@ -125,13 +121,13 @@ If you wish to use the `SADX Music` option of the Randomizer, you must own a cop
125121
2. Select the `Compatibility` tab.
126122
3. Check the `Run this program in compatility mode for:` box and select Windows 7 in the drop down.
127123
4. Click the `Apply` button.
128-
124+
129125
- No resolution options in the Launcher.exe.
130126
- In the `Graphics device` dropdown, select the device and display you plan to run the game on. The `Resolution` dropdown should populate once a graphics device is selected.
131-
127+
132128
- No music is playing in the game.
133129
- If you enabled an `SADX Music` option, then most likely the music data was not copied properly into the mod folder (See Additional Options for instructions).
134-
130+
135131
- Mission 1 is missing a texture in the stage select UI.
136132
- Most likely another mod is conflicting and overwriting the texture pack. It is recommeded to have the SA2B Archipelago mod load last in the mod manager.
137133

0 commit comments

Comments
 (0)