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

worlds/timespinner/__init__.py

@@ -1,5 +1,5 @@
 from typing import Dict, List, Set, Tuple, TextIO
-from BaseClasses import Item, MultiWorld, Location
+from BaseClasses import Item, MultiWorld, Location, Tutorial
 from ..AutoWorld import World, WebWorld
 from .LogicMixin import TimespinnerLogic
 from .Items import get_item_names_per_category, item_table, starter_melee_weapons, starter_spells, starter_progression_items, filler_items
@@ -10,6 +10,25 @@ from .PyramidKeys import get_pyramid_keys_unlock
 
 class TimespinnerWebWorld(WebWorld):
     theme = "ice"
+    setup = Tutorial(
+        "Multiworld Setup Guide",
+        "A guide to setting up the Timespinner randomizer connected to an Archipelago Multiworld",
+        "English",
+        "setup_en.md",
+        "setup/en",
+        ["Jarno"]
+    )
+
+    setup_de = Tutorial(
+        setup.tutorial_name,
+        setup.description,
+        "Deutsch",
+        "setup_de.md",
+        "setup/en",
+        ["Grrmo", "Fynxes", "Blaze0168"]
+    )
+
+    tutorials = [setup, setup_de]
 
 class TimespinnerWorld(World):
     """

worlds/timespinner/docs/en_Timespinner.md

@@ -0,0 +1,38 @@
+# Timespinner
+
+## 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?
+
+Items which the player would normally acquire throughout the game have been moved around. Logic remains, so the game is
+always able to be completed, but because of the item shuffle the player may need to access certain areas before they
+would in the vanilla game. All rings and spells are also randomized into those item locations, therefore you can no
+longer craft them at the alchemist
+
+## What is the goal of Timespinner when randomized?
+
+The goal remains unchanged. Kill the Sandman\Nightmare!
+
+## What items and locations get shuffled?
+
+All main inventory items, orbs, collectables, and familiars can be shuffled, and all locations in the game which could
+contain any of those items may have their contents changed.
+
+## Which items can be in another player's world?
+
+Any of the items which can be shuffled may also be placed into another player's world. It is possible to choose to limit
+certain items to your own world.
+
+## What does another world's item look like in Timespinner?
+
+Items belonging to other worlds are represented by the vanilla item Elemental
+Beads ([Elemental Beads Wiki Page](https://timespinnerwiki.com/Use_Items)), Elemental Beads have no use in the
+randomizer.
+
+## When the player receives an item, what happens?
+
+When the player receives an item, the same items popup will be displayed as when you would normally obtain the item.
+

worlds/timespinner/docs/setup_de.md

@@ -0,0 +1,50 @@
+# Timespinner Randomizer Installationsanweisungen
+
+## Benötigte Software
+
+- [Timespinner (Steam)](https://store.steampowered.com/app/368620/Timespinner/)
+  , [Timespinner (Humble)](https://www.humblebundle.com/store/timespinner)
+  oder [Timespinner (GOG)](https://www.gog.com/game/timespinner) (andere Versionen werden nicht unterstützt)
+- [Timespinner Randomizer](https://github.com/JarnoWesthof/TsRandomizer)
+
+## Wie funktioniert's?
+
+Der Timespinner Randomizer lädt die Timespinner.exe im gleichen Verzeichnis und verändert seine Speicherinformationen um
+die Randomisierung der Gegenstände zu erlauben
+
+## Installationsanweisungen
+
+1. Die aktuellsten Dateien des Randomizers findest du ganz oben auf dieser
+   Webseite: [Timespinner Randomizer Releases](https://github.com/JarnoWesthof/TsRandomizer/releases). Lade dir unter '
+   Assets' die .zip Datei für dein Betriebssystem herunter
+2. Entpacke die .zip Datei im Ordner, in dem das Spiel Timespinner installiert ist
+
+## Den Randomizer starten
+
+- auf Windows: Starte die Datei TsRandomizer.exe
+- auf Linux: Starte die Datei TsRandomizer.bin.x86_64
+- auf Mac: Starte die Datei TsRandomizer.bin.osx
+
+... im Ordner in dem die Inhalte aus der .zip Datei entpackt wurden
+
+Weitere Informationen zum Randomizer findest du hier: [ReadMe](https://github.com/JarnoWesthof/TsRandomizer)
+
+## An einer Multiworld teilnehmen
+
+1. Starte den Randomizer wie unter [Den Randomizer starten](#Den-Randomizer-starten) beschrieben
+2. Wähle "New Game"
+3. Wechsle "<< Select Seed >>" zu "<< Archiplago >>" indem du "links" auf deinem Controller oder der Tastatur drückst
+4. Wähle "<< Archipelago >>" um ein neues Menu zu öffnen, wo du deine Logininformationen für Archipelago eingeben kannst
+    * ANMERKUNG: Die Eingabefelder unterstützen das Einfügen von Informationen mittels 'Ctrl + V'
+5. Wähle "Connect"
+6. Wenn alles funktioniert hat, wechselt das Spiel zurück zur Auswahl des Schwierigkeitsgrads und das Spiel startet,
+   sobald du einen davon ausgewählt hast
+
+## Woher bekomme ich eine Konfigurationsdatei?
+
+Die [Player Settings](https://archipelago.gg/games/Timespinner/player-settings) Seite auf der Website erlaubt dir,
+persönliche Einstellungen zu definieren und diese in eine Konfigurationsdatei zu exportieren
+
+* Die Timespinner Randomizer Option "StinkyMaw" ist in Archipelago Seeds aktuell immer an
+* Die Timespinner Randomizer Optionen "ProgressiveVerticalMovement" & "ProgressiveKeycards" werden in Archipelago Seeds
+  aktuell nicht unterstützt

worlds/timespinner/docs/setup_en.md

@@ -0,0 +1,41 @@
+# Timespinner Randomizer Setup Guide
+
+## Required Software
+
+- [Timespinner (Steam)](https://store.steampowered.com/app/368620/Timespinner/)
+  , [Timespinner (Humble)](https://www.humblebundle.com/store/timespinner)
+  or [Timespinner (GOG)](https://www.gog.com/game/timespinner) (other versions are not supported)
+- [Timespinner Randomizer](https://github.com/JarnoWesthof/TsRandomizer)
+
+## General Concept
+
+The Timespinner Randomizer loads Timespinner.exe from the same folder, and alters its state in memory to allow for
+randomization of the items
+
+## Installation Procedures
+
+Download latest release on [Timespinner Randomizer Releases](https://github.com/JarnoWesthof/TsRandomizer/releases) you
+can find the .zip files on the releases page. Download the zip for your current platform. Then extract the zip to the
+folder where your Timespinner game is installed. Then just run TsRandomizer.exe (on Windows) or
+TsRandomizer.bin.x86_64 (on Linux) or TsRandomizer.bin.osx (on Mac) instead of Timespinner.exe to start the game in
+randomized mode. For more info see the [ReadMe](https://github.com/JarnoWesthof/TsRandomizer)
+
+## Joining a MultiWorld Game
+
+1. Run TsRandomizer.exe
+2. Select "New Game"
+3. Switch "<< Select Seed >>" to "<< Archipelago >>" by pressing left on your controller or keyboard
+4. Select "<< Archipelago >>" to open a new menu where you can enter your Archipelago login credentials
+    * NOTE: the input fields support Ctrl + V pasting of values
+5. Select "Connect"
+6. If all went well you will be taken back to the difficulty selection menu and the game will start as soon as you
+   select a difficulty
+
+## Where do I get a config file?
+
+The [Player Settings](https://archipelago.gg/games/Timespinner/player-settings) page on the website allows you to
+configure your personal settings and export them into a config file
+
+* The Timespinner Randomizer option "StinkyMaw" is currently always enabled for Archipelago generated seeds
+* The Timespinner Randomizer options "ProgressiveVerticalMovement" & "ProgressiveKeycards" are currently not supported
+  on Archipelago generated seeds