Grinch-AP/worlds/timespinner/docs/setup_en.md

# 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](/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
Fixed some bugs + added documentation + added a few features (#87) * Refactorings + minor logic fix * Fixed unnececerly recalculation of item_name_groups * Enabled other itemId's so that they can be send to client when desired * Marked the loss of location 1337158 * Updated network graph * First draft tinmespinner documentation * Moved personal items to slot_data rather than location scouts * Disabled Remote Items * Updated docs * Fixed port override 2021-09-30 19:51:07 +02:00			`# Timespinner Randomizer Setup Guide`

			`## Required Software`

Merge from main and reformat tutorials. 2022-01-17 15:37:34 -05:00			`- [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)`
Fixed some bugs + added documentation + added a few features (#87) * Refactorings + minor logic fix * Fixed unnececerly recalculation of item_name_groups * Enabled other itemId's so that they can be send to client when desired * Marked the loss of location 1337158 * Updated network graph * First draft tinmespinner documentation * Moved personal items to slot_data rather than location scouts * Disabled Remote Items * Updated docs * Fixed port override 2021-09-30 19:51:07 +02:00			`- [Timespinner Randomizer](https://github.com/JarnoWesthof/TsRandomizer)`

			`## General Concept`

Merge from main and reformat tutorials. 2022-01-17 15:37:34 -05:00			`The Timespinner Randomizer loads Timespinner.exe from the same folder, and alters its state in memory to allow for`
			`randomization of the items`
Fixed some bugs + added documentation + added a few features (#87) * Refactorings + minor logic fix * Fixed unnececerly recalculation of item_name_groups * Enabled other itemId's so that they can be send to client when desired * Marked the loss of location 1337158 * Updated network graph * First draft tinmespinner documentation * Moved personal items to slot_data rather than location scouts * Disabled Remote Items * Updated docs * Fixed port override 2021-09-30 19:51:07 +02:00
			`## Installation Procedures`

Merge from main and reformat tutorials. 2022-01-17 15:37:34 -05:00			`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)`

Fixed some bugs + added documentation + added a few features (#87) * Refactorings + minor logic fix * Fixed unnececerly recalculation of item_name_groups * Enabled other itemId's so that they can be send to client when desired * Marked the loss of location 1337158 * Updated network graph * First draft tinmespinner documentation * Moved personal items to slot_data rather than location scouts * Disabled Remote Items * Updated docs * Fixed port override 2021-09-30 19:51:07 +02:00			`## Joining a MultiWorld Game`

			`1. Run TsRandomizer.exe`
			`2. Select "New Game"`
Merge from main and reformat tutorials. 2022-01-17 15:37:34 -05:00			`3. Switch "<< Select Seed >>" to "<< Archipelago >>" by pressing left on your controller or keyboard`
Corrected typos and wrong information - Game executable names for Linux and Mac were wrong - Fixed some typos and changed grammar and semantics in some places 2022-01-09 14:47:28 +01:00			`4. Select "<< Archipelago >>" to open a new menu where you can enter your Archipelago login credentials`
Merge from main and reformat tutorials. 2022-01-17 15:37:34 -05:00			`* NOTE: the input fields support Ctrl + V pasting of values`
Fixed some bugs + added documentation + added a few features (#87) * Refactorings + minor logic fix * Fixed unnececerly recalculation of item_name_groups * Enabled other itemId's so that they can be send to client when desired * Marked the loss of location 1337158 * Updated network graph * First draft tinmespinner documentation * Moved personal items to slot_data rather than location scouts * Disabled Remote Items * Updated docs * Fixed port override 2021-09-30 19:51:07 +02:00			`5. Select "Connect"`
Merge from main and reformat tutorials. 2022-01-17 15:37:34 -05:00			`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`
Fixed some bugs + added documentation + added a few features (#87) * Refactorings + minor logic fix * Fixed unnececerly recalculation of item_name_groups * Enabled other itemId's so that they can be send to client when desired * Marked the loss of location 1337158 * Updated network graph * First draft tinmespinner documentation * Moved personal items to slot_data rather than location scouts * Disabled Remote Items * Updated docs * Fixed port override 2021-09-30 19:51:07 +02:00
[Timespinner] Updated timespinner setup docs (#184) * [Timespinner] Updated setup docs 2022-01-04 22:56:53 +01:00			`## Where do I get a config file?`
Merge from main and reformat tutorials. 2022-01-17 15:37:34 -05:00
docs: update various broken links/images and fix a few small typos. point some links to current webhost server rather than hardcoding archipelago.gg 2022-05-18 14:19:57 -05:00			`The [Player Settings](/games/Timespinner/player-settings) page on the website allows you to`
Merge from main and reformat tutorials. 2022-01-17 15:37:34 -05:00			`configure your personal settings and export them into a config file`
[Timespinner] Updated timespinner setup docs (#184) * [Timespinner] Updated setup docs 2022-01-04 22:56:53 +01:00
Fixed some bugs + added documentation + added a few features (#87) * Refactorings + minor logic fix * Fixed unnececerly recalculation of item_name_groups * Enabled other itemId's so that they can be send to client when desired * Marked the loss of location 1337158 * Updated network graph * First draft tinmespinner documentation * Moved personal items to slot_data rather than location scouts * Disabled Remote Items * Updated docs * Fixed port override 2021-09-30 19:51:07 +02:00			`* The Timespinner Randomizer option "StinkyMaw" is currently always enabled for Archipelago generated seeds`
Merge from main and reformat tutorials. 2022-01-17 15:37:34 -05:00			`* The Timespinner Randomizer options "ProgressiveVerticalMovement" & "ProgressiveKeycards" are currently not supported`
			`on Archipelago generated seeds`