Webworld docs: move gameinfo documentation to their world folders and copy them for webhost use. (#455)

worlds/ror2/__init__.py

@@ -3,13 +3,24 @@ from .Items import RiskOfRainItem, item_table, item_pool_weights
 from .Locations import location_table, RiskOfRainLocation, base_location_table
 from .Rules import set_rules
 
-from BaseClasses import Region, Entrance, Item, MultiWorld
+from BaseClasses import Region, Entrance, Item, MultiWorld, Tutorial
 from .Options import ror2_options
-from ..AutoWorld import World
+from ..AutoWorld import World, WebWorld
 
 client_version = 1
 
 
+class RiskOfWeb(WebWorld):
+    tutorials = [Tutorial(
+        "Multiworld Setup Guide",
+        "A guide to setting up the Risk of Rain 2 integration for Archipelago multiworld games.",
+        "English",
+        "setup_en.md",
+        "setup/en",
+        ["Ijwu"]
+    )]
+
+
 class RiskOfRainWorld(World):
     """
      Escape a chaotic alien planet by fighting through hordes of frenzied monsters – with your friends, or on your own.
@@ -25,6 +36,7 @@ class RiskOfRainWorld(World):
 
     data_version = 3
     forced_auto_forfeit = True
+    web = RiskOfWeb()
 
     def generate_basic(self):
         # shortcut for starting_inventory... The start_with_revive option lets you start with a Dio's Best Friend

worlds/ror2/docs/en_Risk of Rain 2.md

@@ -0,0 +1,43 @@
+# Risk of Rain 2
+
+## 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?
+
+Risk of Rain is already a random game, by virtue of being a roguelite. The Archipelago mod implements pure multiworld
+functionality in which certain chests (made clear via a location check progress bar) will send an item out to the
+multiworld. The items that _would have been_ in those chests will be returned to the Risk of Rain player via grants by
+other players in other worlds.
+
+## What Risk of Rain items can appear in other players' worlds?
+
+The Risk of Rain items are:
+
+* `Common Item`    (White items)
+* `Uncommon Item`  (Green items)
+* `Boss Item`      (Yellow items)
+* `Legendary Item` (Red items)
+* `Lunar Item`     (Blue items)
+* `Equipment`      (Orange items)
+* `Dio's Best Friend` (Used if you set the YAML setting `total_revives_available` above `0`)
+
+Each item grants you a random in-game item from the category it belongs to.
+
+When an item is granted by another world to the Risk of Rain player (one of the items listed above) then a random
+in-game item of that tier will appear in the Risk of Rain player's inventory. If the item grant is an `Equipment` and
+the player already has an equipment item equipped then the _item that was equipped_ will be dropped on the ground and _
+the new equipment_ will take it's place. (If you want the old one back, pick it up.)
+
+## What does another world's item look like in Risk of Rain?
+
+When the Risk of Rain player fills up their location check bar then the next spawned item will become an item grant for
+another player's world. The item in Risk of Rain will disappear in a poof of smoke and the grant will automatically go
+out to the multiworld.
+
+## What is the item pickup step?
+
+The item pickup step is a YAML setting which allows you to set how many items you need to spawn before the _next_ item
+that is spawned disappears (in a poof of smoke) and goes out to the multiworld.

worlds/ror2/docs/setup_en.md

@@ -0,0 +1,107 @@
+# Risk of Rain 2 Setup Guide
+
+## Install using r2modman
+
+### Install r2modman
+
+Head on over to the r2modman page on Thunderstore and follow the installation instructions.
+
+[r2modman Page](https://thunderstore.io/package/ebkr/r2modman/)
+
+### Install Archipelago Mod using r2modman
+
+You can install the Archipelago mod using r2modman in one of two ways.
+
+[Archipelago Mod Download Page](https://thunderstore.io/package/ArchipelagoMW/Archipelago/)
+
+One, you can use the Thunderstore website and click on the "Install with Mod Manager" link.
+
+You can also search for the "Archipelago" mod in the r2modman interface. The mod manager should automatically install
+all necessary dependencies as well.
+
+### Running the Modded Game
+
+Click on the "Start modded" button in the top left in r2modman to start the game with the Archipelago mod installed.
+
+## Joining an Archipelago Session
+
+There will be a menu button on the right side of the screen in the character select menu. 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.
+
+## 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
+  enable_lunar: true
+  item_weights:
+    default: 50
+    new: 0
+    uncommon: 0
+    legendary: 0
+    lunartic: 0
+    chaos: 0
+    no_scraps: 0
+    even: 0
+    scraps_only: 0
+  item_pool_presets: true
+  # custom item weights
+  green_scrap: 16
+  red_scrap: 4
+  yellow_scrap: 1
+  white_scrap: 32
+  common_item: 64
+  uncommon_item: 32
+  legendary_item: 8
+  boss_item: 4
+  lunar_item: 16
+  equipment: 32
+```
+
+| Name | Description | Allowed values |
+| ---- | ----------- | -------------- |
+| total_locations | The total number of location checks that will be attributed to the Risk of Rain player. This option is ALSO the total number of items in the item pool for the Risk of Rain player. | 10 - 100 |
+| 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 |
+| enable_lunar | Allows for lunar items to be shuffled into the item pool on behalf of the Risk of Rain player. | true/false |
+| item_weights | Each option here is a preset item weight that can be used to customize your generate item pool with certain settings. | default, new, uncommon, legendary, lunartic, chaos, no_scraps, even, scraps_only |
+| item_pool_presets | A simple toggle to determine whether the item_weight presets are used or the custom item pool as defined below | true/false |
+| custom item weights | Each defined item here is a single item in the pool that will have a weight against the other items when the item pool gets generated. These values can be modified to adjust how frequently certain items appear | 0-100|
+
+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 have 15 items waiting for them in the item pool which will be distributed out to the multiworld. (
+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)
+
+The player will have lunar items shuffled into the item pool on their behalf. (enable_lunar = true)
+
+The player will have the default preset generated item pool with the custom item weights being ignored. (item_weights:
+default and item_pool_presets: true)