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

worlds/v6/__init__.py

@@ -5,11 +5,23 @@ from .Locations import location_table, V6Location
 from .Options import v6_options
 from .Rules import set_rules
 from .Regions import create_regions
-from BaseClasses import Region, RegionType, Entrance, Item, MultiWorld
-from ..AutoWorld import World
+from BaseClasses import Region, RegionType, Entrance, Item, MultiWorld, Tutorial
+from ..AutoWorld import World, WebWorld
 
 client_version = 1
 
+
+class V6Web(WebWorld):
+    tutorials = [Tutorial(
+        "Multiworld Setup Guide",
+        "A guide to setting up VVVVVV for Multiworld.",
+        "English",
+        "setup_en.md",
+        "setup/en",
+        ["N00byKing"]
+    )]
+
+
 class V6World(World):
     """ 
      VVVVVV is a platform game all about exploring one simple mechanical idea - what if you reversed gravity instead of jumping?
@@ -17,6 +29,7 @@ class V6World(World):
 
     game: str = "VVVVVV"
     topology_present = False
+    web = V6Web()
 
     item_name_to_id = item_table
     location_name_to_id = location_table

worlds/v6/docs/en_VVVVVV.md

@@ -0,0 +1,36 @@
+# VVVVVV
+
+## Where is the settings page?
+
+The player settings page for this game contains all the options you need to configure and export a config file. Player
+settings page link: [VVVVVV Player Settings Page](../player-settings).
+
+## What does randomization do to this game?
+All 20 Trinkets are now Location Checks and may not actually contain Trinkets, but Items for different games.
+
+Optionally, you may enable DoorCost, which will gate away some areas:
+- Laboratory
+- The Tower
+- Space Station 2 and
+- Warp Zone
+until you've collected some Trinkets.
+Examples:
+- If you set DoorCost at 2, then to enter Laboratory you will need Trinkets 1-2, for The Tower 3-4, etc.
+- If you set DoorCost at 3, then to enter Laboratory you will need Trinkets 1-3, for The Tower 4-6, etc.
+
+## What is the goal of VVVVVV when randomized?
+Save all crew members, and finish the story.
+
+## Which items can be in another player's world?
+Any of the 20 Trinkets.
+
+## What does another world's item look like in VVVVVV?
+The Trinkets are visually unchanged, though after collecting a textbox will pop up to inform you what you collected,
+and who will receive it.
+
+## When the player receives an item, what happens?
+When you receive a Trinket, the standard Animation will play. Afterwards a textbox will inform you where
+you received the Trinket from, and which one it is.
+
+NOTE: You can't check your trinkets in the Spaceship. Instead, you can check them in the pause menu under 'Stats'.
+This is especially useful if you have DoorCost enabled.

worlds/v6/docs/setup_en.md

@@ -0,0 +1,43 @@
+# VVVVVV MultiWorld Setup Guide
+
+## Required Software
+
+- VVVVVV (Bought from the [Steam Store](https://store.steampowered.com/app/70300/VVVVVV/) or [GOG Store](https://www.gog.com/game/vvvvvv) Page, NOT Make and Play Edition!)
+- [V6AP](https://github.com/N00byKing/VVVVVV/releases)
+
+## Installation and Game Start Procedures
+
+1. Install VVVVVV through either Steam or GOG
+2. Go to the page linked for V6AP, and download the latest release
+3. Unpack the zip file where you have VVVVVV installed.
+
+# Joining a MultiWorld Game
+
+To join, set the following launch options: `-v6ap_name YourName -v6ap_ip ServerIP:Port`.
+Optionally, add `-v6ap_passwd "YourPassword"` if the room you are using requires a password. All parameters without quotation marks.
+The Name in this case is the one specified in your generated .yaml file.
+In case you are using the Archipelago Website, the IP should be `archipelago.gg`.
+
+If everything worked out, you will see a textbox informing you the connection has been established after the story intro.
+
+# Playing offline
+
+To play offline, first generate a seed on the game's settings page.
+Create a room and download the `.apv6` file, and start the game with the `-v6ap_file FileName` launch argument.
+
+## Installation Troubleshooting
+
+Start the game from the command line to view helpful messages regarding V6AP. These will look something like "V6AP: Message"
+
+### Game no longer starts after copying the .exe
+
+Most likely you forgot to set the launch options. `-v6ap_name YourName` and `-v6ap_ip ServerIP:Port` are required for startup for Multiworlds, and
+`-v6ap_file FileName` is required for (offline) singleplayer.
+If your Name or Password have spaces in them, surround them in quotes.
+
+## Game Troubleshooting
+
+### What happens if I lose connection?
+
+V6AP tries to reconnect a few times, so be patient.
+Should the problem still be there after about a minute or two, just save and restart the game.