Skip to content

Commit c58b5ae

Browse files
authored
Small updates to address comments (ArchipelagoMW#9)
* Fixup links, bullet points, instructions * Website update v2 * Standardize markdown * Add new section * Prefix rules with raft_ * Oops forgot this
1 parent 5b8e7aa commit c58b5ae

File tree

3 files changed

+129
-112
lines changed

3 files changed

+129
-112
lines changed

WebHostLib/static/assets/gameInfo/en_Raft.md

+8-1
Original file line numberDiff line numberDiff line change
@@ -22,4 +22,11 @@ Decoration Packages are unchanged.
2222
Researches and pickups remain visually unchanged, regardless of what the unlock is.
2323

2424
## When the player receives an item, what happens?
25-
A Raft notification will appear with the item information. The unlock will also appear in the chat. Unlocks that would normally give you the item (eg Machete) will NOT give it to you, but must instead be crafted.
25+
A Raft notification will appear with the item information. The unlock will also appear in the chat. Unlocks that would normally give you the item (eg Machete) will NOT give it to you, but must instead be crafted.
26+
27+
## Are there any limitations compared to vanilla Raft?
28+
- Raftipelago only supports **one player per Raft world**. Multiple players can technically join, but this will very likely break how Raftipelago handles events.
29+
- Mods that add new researchable technologies, modify story islands, or give items like blueprints are likely incompatible with Raftipelago.
30+
- Some mods that add items that are always craftable (eg don't add them to the Research Table) may be compatible.
31+
- Mods that do not affect items, notes, blueprints, or story islands have a good chance of being compatible with Raftipelago
32+
- No mods have been comprehensively tested or verified to work with Raftipelago. Use at your own risk.

WebHostLib/static/assets/tutorial/raft/setup_en.md

+29-19
Original file line numberDiff line numberDiff line change
@@ -4,37 +4,47 @@
44

55
- [Raft](https://store.steampowered.com/app/648800/Raft/)
66
- [Raft Mod Loader](https://www.raftmodding.com/loader) ("*RML*")
7-
- [Raftipelago mod](https://www.raftmodding.com/raftipelago)
7+
- [Raftipelago mod](https://www.raftmodding.com/mods/raftipelago)
88

99
## Installation Procedures
1010

1111
1. Install Raft. The currently-supported Raft version is Update 13: The Renovation Update. If you plan on playing Raft mainly with Archipelago, it's recommended to disable Raft auto-updating through Steam, as there is no beta channel to get old builds.
1212

13-
2. Install RML. If you've already installed it, the shortcut in the Start Menu is called "RMLLauncher.exe".
13+
2. Install RML.
1414

15-
3. Install the Raftipelago mod from the Raft Modding website. This requires that you open the link on the webpage through RML. Alternatively, you can download the .rmod file and place it in the Mods folder manually.
15+
3. Install the Raftipelago mod from the Raft Modding website. You should open the auto-installation link on the webpage through RML. Alternatively, you can download the .rmod file and place it in the Mods folder manually.
1616

17-
4. Start Raft through Steam. Wait for it to load into the main menu.
17+
4. Open RML and click Play. If you've already installed it, the shortcut in the Start Menu is called "RMLLauncher.exe". Raft should start.
1818

19-
5. Once the Raft main menu loads, open RML and click Play. Wait a few seconds after it says "Successfully injected" for RML to appear in Raft.
19+
5. Open the RML menu. This should open automatically when Raft first loads. If it does not, and you see RML information in the top center of the Raft main menu, press F9 to open it.
2020

21-
6. Open the RML menu. After RML injects, this should open automatically. If it does not, and you see RML information in the top center of the Raft main menu, press F9 to open it.
21+
6. Navigate to the "Mod manager" tab in the left-hand menu.
2222

23-
7. Navigate to the "Mod manager" tab in the left-hand menu.
24-
25-
8. Click on the plug icon for Raftipelago to load the mod.
23+
7. Click on the plug icon for Raftipelago to load the mod.
2624

2725
## Installation Troubleshooting
2826

2927
You can press F10 to open the console to view any errors when loading the mod.
3028

3129
### DLL/Reflection/Image errors
3230

33-
Restart Raft and try again. Although RML may be able to start Raft instead of you starting it through Steam, try specifically opening Raft through Steam (not RML), then clicking Play in RML once you're on the Raft main menu.
31+
Restart Raft and try again. These should be ephemeral errors.
32+
33+
### RML says to start Raft through Steam
34+
35+
If this happens, then RML is configured to only inject into an existing instance of Raft, rather than try and start a new one.
36+
37+
You can either:
38+
- Click "Play" after Raft has loaded into the main menu
39+
- Uncheck the box next to the "Disable Automatic Game Start" setting in the Settings menu then click Play.
40+
41+
### RML doesn't do anything when I click Play
3442

35-
### RML can't find Raft
43+
If this happens, then RML is configured to only start a new instance of Raft, then inject into that specific instance. This also means that RML has detected an instance of Raft is already running, and will not start a new one.
3644

37-
Restart Raft and try again. Try running RML as administrator by right-clicking the shortcut and clicking "Run as administrator".
45+
You can either:
46+
- Close the existing instance of Raft then click Play
47+
- Check the box next to the "Disable Automatic Game Start" setting in the Settings menu then click Play.
3848

3949
## Joining a MultiWorld Game
4050

@@ -43,16 +53,16 @@ Restart Raft and try again. Try running RML as administrator by right-clicking t
4353
2. Open the Debug Console by pressing F10.
4454

4555
3. Type */connect {serverAddress} {username} {password}* into the console and hit Enter.
46-
- Example: */connect archipelago.gg:12345 SunnyBat*
47-
- serverAddress must not contain spaces.
48-
- If your username or password contains spaces, surround that value with quotation marks ("). Adding quotation marks even when not necessary (eg "SunnyBat") is fine.
49-
- If your username or password starts with a quotation mark, surround the value with an additional set of quotation marks (eg the value *"myP@s$w0rD* would be entered as *""myP@s$w0rD"*).
56+
- Example: */connect archipelago.gg:12345 SunnyBat*
57+
- serverAddress must not contain spaces.
58+
- If your username or password contains spaces, surround that value with quotation marks ("). Adding quotation marks even when not necessary (eg "SunnyBat") is fine.
59+
- If your username or password starts with a quotation mark, surround the value with an additional set of quotation marks (eg the value *"myP@s$w0rD* would be entered as *""myP@s$w0rD"*).
5060

5161
4. Start a new game or load an existing one.
52-
- Raftipelago save games are marked as *incompatible* with
53-
- Do not use an existing game that was not created with Raftipelago. It will work, but if anything is unlocked, it will be automatically registered with Archipelago once the world is loaded. This is irreversible.
62+
- Raftipelago save games are marked as *incompatible* with vanilla Raft. This means when Raftipelago is not loaded, saves made with Raftipelago will show as corrupt/unselectable.
63+
- Avoid using an existing game that was not created with your current run of Raftipelago (either vanilla or a different Raftipelago run). It will work, but if anything is unlocked, it will be automatically registered with Archipelago once the world is loaded. This is irreversible.
5464

55-
5. You can disconnect by typing */disconnect confirmDisconnect* into the console and hitting Enter.
65+
5. You can disconnect from an Archipelago server by typing */disconnect confirmDisconnect* into the console and hitting Enter.
5666

5767
## Game Troubleshooting
5868

0 commit comments

Comments
 (0)