monorail
/
Archipelago
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

WebHost: I have not been doing hyperlinks in an accessible fashion. I thought I was. I have failed you. 

Follow this advice: https://www.imperial.ac.uk/staff/tools-and-reference/web-guide/training-and-events/materials/accessibility/links/
This commit is contained in:
Hussein Farran 2021-12-02 20:39:24 -05:00
parent 5b399bff89
commit 71e5348cbb
6 changed files with 43 additions and 43 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
WebHostLib/static/assets/tutorial/Subnautica/setup_en.md
View File

@ -2,9 +2,9 @@
## Required Software
- Subnautica from: [https://store.steampowered.com/app/264710/Subnautica/](https://store.steampowered.com/app/264710/Subnautica/)
- QModManager4 from: [https://www.nexusmods.com/subnautica/mods/201](https://www.nexusmods.com/subnautica/mods/201)
- Archipelago Mod for Subnautica from: [https://github.com/Berserker66/ArchipelagoSubnauticaModSrc/releases](https://github.com/Berserker66/ArchipelagoSubnauticaModSrc/releases)
- Subnautica from: [Subnautica Steam Store Page](https://store.steampowered.com/app/264710/Subnautica/)
- QModManager4 from: [QModManager4 Nexus Mods Page](https://www.nexusmods.com/subnautica/mods/201)
- Archipelago Mod for Subnautica from: [Subnautica Archipelago Mod Releases Page](https://github.com/Berserker66/ArchipelagoSubnauticaModSrc/releases)
## Installation Procedures

10
WebHostLib/static/assets/tutorial/minecraft/minecraft_en.md
View File

@ -1,17 +1,17 @@
# Minecraft Randomizer Setup Guide
#Automatic Hosting Install
- Download and install Archipelago at: [https://github.com/ArchipelagoMW/Archipelago/releases](https://github.com/ArchipelagoMW/Archipelago/releases)
- Download and install Archipelago at: [Archipelago Releases Page](https://github.com/ArchipelagoMW/Archipelago/releases)
- Choose the `Minecraft Client` module during the installation.
## Required Software
- Minecraft Java Edition from: [https://www.minecraft.net/en-us/store/minecraft-java-edition](https://www.minecraft.net/en-us/store/minecraft-java-edition)
- Minecraft Java Edition from: [Minecraft Java Edition Store Page](https://www.minecraft.net/en-us/store/minecraft-java-edition)
## Configuring your YAML file
### What is a YAML file and why do I need one?
See the guide on setting up a basic YAML at the Archipelago setup guide: [click here](/tutorial/archipelago/setup/en)
See the guide on setting up a basic YAML at the Archipelago setup guide: [Basic Multiworld Setup Guide](/tutorial/archipelago/setup/en)
### What Does a YAML Look Like for Minecraft?
A basic minecraft yaml will look like this.
@ -104,8 +104,8 @@ When the console tells you that you have joined the room, you're ready to begin
This is only required if you wish to set up a forge install yourself, it's recommended to just use the Archipelago Installer.
###Required Software
- Minecraft Forge from: [https://files.minecraftforge.net/net/minecraftforge/forge/index_1.16.5.html](https://files.minecraftforge.net/net/minecraftforge/forge/index_1.16.5.html)
- Minecraft Archipelago Randomizer Mod from: [https://github.com/KonoTyran/Minecraft_AP_Randomizer/releases](https://github.com/KonoTyran/Minecraft_AP_Randomizer/releases)
- Minecraft Forge from: [Minecraft Forge Download Page](https://files.minecraftforge.net/net/minecraftforge/forge/index_1.16.5.html)
- Minecraft Archipelago Randomizer Mod from: [AP Randomizer Forge Server Mod Releases Page](https://github.com/KonoTyran/Minecraft_AP_Randomizer/releases)
- **DO NOT INSTALL THIS ON YOUR CLIENT**
### Dedicated Server Setup
Only one person has to do this setup and host a dedicated server for everyone else playing to connect to.

4
WebHostLib/static/assets/tutorial/ror2/setup_en.md
View File

@ -4,12 +4,12 @@
### Install r2modman
Head on over to the r2modman page on Thunderstore and follow the installation instructions.
[https://thunderstore.io/package/ebkr/r2modman/](https://thunderstore.io/package/ebkr/r2modman/)
[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.
[https://thunderstore.io/package/ArchipelagoMW/Archipelago/](https://thunderstore.io/package/ArchipelagoMW/Archipelago/)
[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.

32
WebHostLib/static/assets/tutorial/secret-of-evermore/multiworld_en.md
View File

@ -1,45 +1,45 @@
# Secret of Evermore Setup Guide
## Required Software
- SNI from: [https://github.com/alttpo/sni/releases](https://github.com/alttpo/sni/releases)
- SNI from: [SNI Releases Page](https://github.com/alttpo/sni/releases)
- v0.0.59 or newer (included in Archipelago 0.2.1 setup)
- Hardware or software capable of loading and playing SNES ROM files
- An emulator capable of connecting to SNI with ROM access. Any one of the following will work:
- snes9x-rr from: [https://github.com/gocha/snes9x-rr/releases](https://github.com/gocha/snes9x-rr/releases)
- BizHawk from: [http://tasvideos.org/BizHawk.html](http://tasvideos.org/BizHawk.html)
- bsnes-plus-nwa from: [https://github.com/black-sliver/bsnes-plus](https://github.com/black-sliver/bsnes-plus)
- Or SD2SNES, FXPak Pro ([https://krikzz.com/store/home/54-fxpak-pro.html](https://krikzz.com/store/home/54-fxpak-pro.html)), or other compatible hardware.
- snes9x-rr from: [snes9x-rr Releases Page](https://github.com/gocha/snes9x-rr/releases)
- BizHawk from: [BizHawk Website](http://tasvideos.org/BizHawk.html)
- bsnes-plus-nwa from: [bsnes-plus GitHub](https://github.com/black-sliver/bsnes-plus)
- Or SD2SNES, FXPak Pro ([FXPak Pro Store Page](https://krikzz.com/store/home/54-fxpak-pro.html)), or other compatible hardware.
- Your legally obtained Secret of Evermore US ROM file, probably named `Secret of Evermore (USA).sfc`
## Create a Config (.yaml) File
### What is a config file and why do I need one?
See the guide on setting up a basic YAML at the Archipelago setup guide: [click here](/tutorial/archipelago/setup/en)
See the guide on setting up a basic YAML at the Archipelago setup guide: [Basic Multiworld Setup Guide](/tutorial/archipelago/setup/en)
### Where do I get a config file?
The Player Settings page on the website allows you to configure your personal settings and export a config file from them. Player settings page: [click here](/games/Secret%20of%20Evermore/player-settings)
The Player Settings page on the website allows you to configure your personal settings and export a config file from them. Player settings page: [Secret of Evermore Player Settings PAge](/games/Secret%20of%20Evermore/player-settings)
### Verifying your config file
If you would like to validate your config file to make sure it works, you may do so on the YAML Validator page: [click here](/mysterycheck)
If you would like to validate your config file to make sure it works, you may do so on the YAML Validator page: [YAML Validation page](/mysterycheck)
## Generating a Single-Player Game
Stand-alone "Evermizer" has a way of balancing single-player games, but may not always be on par feature-wise. Head over to [https://evermizer.com](https://evermizer.com) if you want to try the official stand-alone, otherwise read below.
Stand-alone "Evermizer" has a way of balancing single-player games, but may not always be on par feature-wise. Head over to the [Evermizer Website](https://evermizer.com) if you want to try the official stand-alone, otherwise read below.
1. Navigate to the Player Settings page, configure your options, and
click the "Generate Game" button.
- Player Settings page: [click here](/games/Secret%20of%20Evermore/player-settings)
- Player Settings page: [Secret of Evermore Player Settings Page](/games/Secret%20of%20Evermore/player-settings)
2. You will be presented with a "Seed Info" page.
3. Click the "Create New Room" link.
4. You will be presented with a server page, from which you can download your patch file.
5. Run your patch file through the apbpatch on evermizer.com and load it in your emulator or console.
* apbpatch page: [click here](https://evermizer.com/apbpatch)
* apbpatch page: [Evermizer apbpatch Page](https://evermizer.com/apbpatch)
## Joining a MultiWorld Game
### Obtain your patch file and create your ROM
When you join a multiworld game, you will be asked to provide your config file to whoever is hosting. Once that is done, the host will provide you with either a link to download your patch file, or with a zip file containing everyone's patch files. Your patch file should have a `.apsoe` extension.
Put your patch file on your desktop or somewhere convenient, open the apbpatch page on evermizer.com and generate your ROM from it. Load the ROM file in your emulator or console. apbpatch page: [https://evermizer.com/apbpatch](https://evermizer.com/apbpatch)
Put your patch file on your desktop or somewhere convenient, open the apbpatch page on evermizer.com and generate your ROM from it. Load the ROM file in your emulator or console. apbpatch page: [Evermizer apbpatch Page](https://evermizer.com/apbpatch)
### Connect to SNI
@ -74,15 +74,15 @@ This should automatically connect to SNI.
If this is its first time launching, you may be prompted to allow it to communicate through the Windows Firewall.
#### With hardware
This guide assumes you have downloaded the correct firmware for your device. If you have not done so already, please do this now. SD2SNES and FXPak Pro users may download the appropriate firmware on the SD2SNES releases page. SD2SNES releases page: [https://github.com/RedGuyyyy/sd2snes/releases](https://github.com/RedGuyyyy/sd2snes/releases)
This guide assumes you have downloaded the correct firmware for your device. If you have not done so already, please do this now. SD2SNES and FXPak Pro users may download the appropriate firmware on the SD2SNES releases page. SD2SNES releases page: [SD2SNES Releases Page](https://github.com/RedGuyyyy/sd2snes/releases)
Other hardware may find helpful information on the usb2snes platforms page: [http://usb2snes.com/#supported-platforms](http://usb2snes.com/#supported-platforms)
Other hardware may find helpful information on the usb2snes platforms page: [usb2snes Supported Platforms Page](http://usb2snes.com/#supported-platforms)
1. Copy the ROM file to your SD card.
2. Load the ROM file from the menu.
### Open the client
Open ap-soeclient ([http://evermizer.com/apclient](http://evermizer.com/apclient)) in a modern browser. Do not switch tabs, open it in a new window if you want to use the browser while playing. Do not minimize the window with the client.
Open ap-soeclient ([Evermizer Archipelago Client Page](http://evermizer.com/apclient)) in a modern browser. Do not switch tabs, open it in a new window if you want to use the browser while playing. Do not minimize the window with the client.
The client should automatically connect to SNI, the "SNES" status should change to green.
@ -98,7 +98,7 @@ The recommended way to host a game is to use our hosting service. The process is
1. Collect config files from your players.
2. Create a zip file containing your players' config files.
3. Upload that zip file to the generate page.
- Generate page: [click here](/generate)
- Generate page: [WebHost Seed Generation Page](/generate)
4. Wait a moment while the seed is generated.
5. When the seed is generated, you will be redirected to a "Seed Info" page.
6. Click "Create New Room". This will take you to the server page. Provide the link to this page to your players,

24
WebHostLib/static/assets/tutorial/super-metroid/multiworld_en.md
View File

@ -1,15 +1,15 @@
# Super Metroid Setup Guide
## Required Software
- Super Metroid Client from: [https://github.com/ArchipelagoMW/SuperMetroidClient/releases](https://github.com/ArchipelagoMW/SuperMetroidClient/releases)
- Super Metroid Client from: [Super Metroid Client Releases Page](https://github.com/ArchipelagoMW/SuperMetroidClient/releases)
- **sniConnector.lua** (located on the client download page)
- SNI from: [https://github.com/alttpo/sni/releases](https://github.com/alttpo/sni/releases)
- SNI from: [SNI Releases Page](https://github.com/alttpo/sni/releases)
- Included in the Super Metroid Client
- Hardware or software capable of loading and playing SNES ROM files
- An emulator capable of connecting to SNI such as:
- snes9x Multitroid from: [https://drive.google.com/drive/folders/1_ej-pwWtCAHYXIrvs5Hro16A1s9Hi3Jz](https://drive.google.com/drive/folders/1_ej-pwWtCAHYXIrvs5Hro16A1s9Hi3Jz),
- BizHawk from: [http://tasvideos.org/BizHawk.html](http://tasvideos.org/BizHawk.html)
- An SD2SNES, FXPak Pro ([https://krikzz.com/store/home/54-fxpak-pro.html](https://krikzz.com/store/home/54-fxpak-pro.html)), or other compatible hardware
- snes9x Multitroid from: [snes9x Multitroid Download](https://drive.google.com/drive/folders/1_ej-pwWtCAHYXIrvs5Hro16A1s9Hi3Jz),
- BizHawk from: [BizHawk Website](http://tasvideos.org/BizHawk.html)
- An SD2SNES, FXPak Pro ([FXPak Pro Store Page](https://krikzz.com/store/home/54-fxpak-pro.html)), or other compatible hardware
- Your legally obtained Super Metroid ROM file, probably named `Super Metroid (Japan, USA).sfc`
## Installation Procedures
@ -33,18 +33,18 @@ for launching ROM files.
## Create a Config (.yaml) File
### What is a config file and why do I need one?
See the guide on setting up a basic YAML at the Archipelago setup guide: [click here](/tutorial/archipelago/setup/en)
See the guide on setting up a basic YAML at the Archipelago setup guide: [Basic Multiworld Setup Guide](/tutorial/archipelago/setup/en)
### Where do I get a config file?
The Player Settings page on the website allows you to configure your personal settings and export a config file from them. Player settings page: [click here](/games/Super%20Metroid/player-settings)
The Player Settings page on the website allows you to configure your personal settings and export a config file from them. Player settings page: [Super Metroid Player Settings Page](/games/Super%20Metroid/player-settings)
### Verifying your config file
If you would like to validate your config file to make sure it works, you may do so on the YAML Validator page. YAML validator page: [click here](/mysterycheck)
If you would like to validate your config file to make sure it works, you may do so on the YAML Validator page. YAML validator page: [YAML Validation page](/mysterycheck)
## Generating a Single-Player Game
1. Navigate to the Player Settings page, configure your options, and click
the "Generate Game" button.
- Player Settings page: [click here](/games/Super%20Metroid/player-settings)
- Player Settings page: [Super Metroid Player Settings Page](/games/Super%20Metroid/player-settings)
2. You will be presented with a "Seed Info" page.
3. Click the "Create New Room" link.
4. You will be presented with a server page, from which you can download your patch file.
@ -81,9 +81,9 @@ When the client launched automatically, SNI should have also automatically launc
5. Select the `sniConnector.lua` file you downloaded above
#### With hardware
This guide assumes you have downloaded the correct firmware for your device. If you have not done so already, please do this now. SD2SNES and FXPak Pro users may download the appropriate firmware on the SD2SNES releases page. SD2SNES releases page: [https://github.com/RedGuyyyy/sd2snes/releases](https://github.com/RedGuyyyy/sd2snes/releases)
This guide assumes you have downloaded the correct firmware for your device. If you have not done so already, please do this now. SD2SNES and FXPak Pro users may download the appropriate firmware on the SD2SNES releases page. SD2SNES releases page: [SD2SNES Releases Page](https://github.com/RedGuyyyy/sd2snes/releases)
Other hardware may find helpful information on the usb2snes platforms page: [http://usb2snes.com/#supported-platforms](http://usb2snes.com/#supported-platforms)
Other hardware may find helpful information on the usb2snes platforms page: [usb2snes Supported Platforms Page](http://usb2snes.com/#supported-platforms)
1. Close your emulator, which may have auto-launched.
2. Power on your device and load the ROM.
@ -102,7 +102,7 @@ The recommended way to host a game is to use our hosting service. The process is
1. Collect config files from your players.
2. Create a zip file containing your players' config files.
3. Upload that zip file to the Generate page above.
- Generate page: [click here](/generate)
- Generate page: [WebHost Seed Generation Page](/generate)
4. Wait a moment while the seed is generated.
5. When the seed is generated, you will be redirected to a "Seed Info" page.
6. Click "Create New Room". This will take you to the server page. Provide the link to this page to your players,

10
WebHostLib/static/assets/tutorial/timespinner/setup_en.md
View File

@ -3,9 +3,9 @@
## Required Software
- One of:
- Timespinner (steam) from: [https://store.steampowered.com/app/368620/Timespinner/](https://store.steampowered.com/app/368620/Timespinner/)
- Timespinner (drm free) from: [https://www.humblebundle.com/store/timespinner](https://www.humblebundle.com/store/timespinner)
- Timespinner Randomizer from: [https://github.com/JarnoWesthof/TsRandomizer](https://github.com/JarnoWesthof/TsRandomizer)
- Timespinner (steam) from: [Timespinner Steam Store Page](https://store.steampowered.com/app/368620/Timespinner/)
- Timespinner (drm free) from: [Timespinner Humble Store Page](https://www.humblebundle.com/store/timespinner)
- Timespinner Randomizer from: [Timespinner Randomizer GitHub](https://github.com/JarnoWesthof/TsRandomizer)
## General Concept
@ -15,9 +15,9 @@ The timespinner Randomizer loads Timespinner.exe from the same folder, and alter
Download latest version of Timespinner randomizer 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 instead of Timespinner.exe to start the game in randomized mode, for more info see the Timespinner randomizer readme.
Timespinner Randomizer downloads page: [https://github.com/JarnoWesthof/TsRandomizer](https://github.com/JarnoWesthof/TsRandomizer)
Timespinner Randomizer downloads page: [Timespinner Randomizer Releases](https://github.com/JarnoWesthof/TsRandomizer/releases)
Timespinner Randomizer readme page: [https://github.com/JarnoWesthof/TsRandomizer](https://github.com/JarnoWesthof/TsRandomizer)
Timespinner Randomizer readme page: [Timespinner Randomizer GitHub](https://github.com/JarnoWesthof/TsRandomizer)
## Joining a MultiWorld Game