From 2f4b248a45b5ebc6ea19c7020336514f9fc1b311 Mon Sep 17 00:00:00 2001 From: Hussein Farran Date: Tue, 31 Aug 2021 00:25:48 -0400 Subject: [PATCH] Add more information to the RoR2 docs. --- .../static/assets/tutorial/ror2/setup_en.md | 34 ++++++++++++++++++- 1 file changed, 33 insertions(+), 1 deletion(-) diff --git a/WebHostLib/static/assets/tutorial/ror2/setup_en.md b/WebHostLib/static/assets/tutorial/ror2/setup_en.md index e1c8f041..5d2d16df 100644 --- a/WebHostLib/static/assets/tutorial/ror2/setup_en.md +++ b/WebHostLib/static/assets/tutorial/ror2/setup_en.md @@ -25,4 +25,36 @@ Click it in order to bring up the in lobby mod config. From here you can expand the Archipelago sections and fill in the relevant info. Keep password blank if there is no password on the server. -Simply check `Enable Archipelago?` and when you start the run it will automatically connect. \ No newline at end of file +Simply check `Enable Archipelago?` and when you start the run it will automatically connect. + +## Gameplay +The Risk of Rain 2 players send checks by causing items to spawn in-game. That means opening chests or killing bosses, generally. +An item check is only sent out after a certain number of items are picked up. This count is configurable in the player's YAML. + +## YAML Settings +An example YAML would look like this: +```yaml +description: Ijwu-ror2 +name: Ijwu + +game: + Risk of Rain 2: 1 + +Risk of Rain 2: + total_locations: 15 + total_revivals: 4 + start_with_revive: true + item_pickup_step: 1 +``` + +| Name | Description | Allowed values | +| ---- | ----------- | -------------- | +| total_locations | The total number of location checks that will be attributed to the Risk of Rain player. | 10 - 50 | +| total_revivals | The total number of items in the Risk of Rain player's item pool (items other players pick up for them) replaced with `Dio's Best Friend`. | 0 - 5 | +| start_with_revive | Starts the player off with a `Dio's Best Friend`. Functionally equivalent to putting a `Dio's Best Friend` in your `starting_inventory`. | true/false | +| item_pickup_step | The number of item pickups which you are allowed to claim before they become an Archipelago location check. | 0 - 5 | + +Using the example YAML above: the Risk of Rain 2 player will have 15 total items which they can pick up for other players (total_locations = 15). +They will complete a location check every second item (item_pickup_step = 1). +They will have 4 of the items which other players can grant them replaced with `Dio's Best Friend`. (total_revivals = 4). +The player will also start with a `Dio's Best Friend`. (start_with_revive = true) \ No newline at end of file