morgan/Grinch-AP
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

TUNIC: Update setup guide and game page docs (#2832)

Browse Source
This commit is contained in:
Silent
2024-03-05 10:54:18 -05:00
committed by GitHub
parent ce43c52589
commit 45a15004a4
2 changed files with 33 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

41
worlds/tunic/docs/setup_en.md
View File

@@ -1,16 +1,17 @@
# TUNIC Setup Guide
## Installation
### Required Software
## Required Software
- [TUNIC](https://tunicgame.com/) for PC (Steam Deck also supported)
- [BepInEx](https://builds.bepinex.dev/projects/bepinex_be/572/BepInEx_UnityIL2CPP_x64_9c2b17f_6.0.0-be.572.zip)
- [TUNIC Randomizer Archipelago Mod](https://github.com/silent-destroyer/tunic-randomizer-archipelago/releases/latest)
- [BepInEx (Unity IL2CPP)](https://github.com/BepInEx/BepInEx/releases/tag/v6.0.0-pre.1)
- [TUNIC Randomizer Mod](https://github.com/silent-destroyer/tunic-randomizer/releases/latest)
### Optional Software
## Optional Software
- [TUNIC Randomizer Map Tracker](https://github.com/SapphireSapphic/TunicTracker/releases/latest) (For use with EmoTracker/PopTracker)
- [TUNIC Randomizer Item Auto-tracker](https://github.com/radicoon/tunic-rando-tracker/releases/latest)
- [Archipelago Text Client](https://github.com/ArchipelagoMW/Archipelago/releases/latest)
## Installation
### Find Your Relevant Game Directories
@@ -24,29 +25,30 @@ Find your TUNIC game installation directory:
### Install BepInEx
BepInEx is a general purpose framework for modding Unity games, and is used by the TUNIC Randomizer.
BepInEx is a general purpose framework for modding Unity games, and is used to run the TUNIC Randomizer.
Download [BepInEx](https://builds.bepinex.dev/projects/bepinex_be/572/BepInEx_UnityIL2CPP_x64_9c2b17f_6.0.0-be.572.zip).
Download [BepInEx](https://github.com/BepInEx/BepInEx/releases/download/v6.0.0-pre.1/BepInEx_UnityIL2CPP_x64_6.0.0-pre.1.zip).
If playing on Steam Deck, follow this [guide to set up BepInEx via Proton](https://docs.bepinex.dev/articles/advanced/proton_wine.html).
Extract the contents of the BepInEx .zip file into your TUNIC game directory:<br>
- **Steam**: Steam\steamapps\common\TUNIC<br>
- **PC Game Pass**: XboxGames\Tunic\Content<br>
- **Other platforms**: Place into the same folder that the Tunic_Data/Secret Legend_Data folder is found.
- **Other platforms**: Place into the same folder that the Tunic_Data or Secret Legend_Data folder is found.
Launch the game once and close it to finish the BepInEx installation.
### Install The TUNIC Randomizer Archipelago Client Mod
### Install The TUNIC Randomizer Mod
Download the latest release of the [TUNIC Randomizer Archipelago Mod](https://github.com/silent-destroyer/tunic-randomizer-archipelago/releases/latest).
Download the latest release of the [TUNIC Randomizer Mod](https://github.com/silent-destroyer/tunic-randomizer/releases/latest).
The downloaded .zip will contain a folder called `Tunic Archipelago`.
Extract the contents of the downloaded .zip file, and find the folder labeled `Tunic Randomizer`.
Copy the `Tunic Archipelago` folder into `BepInEx/plugins` in your TUNIC game installation directory.
The filepath to the mod should look like `BepInEx/plugins/Tunic Archipelago/TunicArchipelago.dll`<br>
Copy the `Tunic Randomizer` folder into `BepInEx/plugins` in your TUNIC game installation directory.
Launch the game, and if everything was installed correctly you should see `Randomizer + Archipelago Mod Ver. x.y.z` in the top left corner of the title screen!
The filepath to the mod should look like `BepInEx/plugins/Tunic Randomizer/TunicRandomizer.dll`<br>
Launch the game, and if everything was installed correctly you should see `Randomizer Mod Ver. x.y.z` in the top left corner of the title screen!
## Configure Archipelago Options
@@ -55,11 +57,12 @@ Launch the game, and if everything was installed correctly you should see `Rando
Visit the [TUNIC options page](/games/Tunic/player-options) to generate a YAML with your selected options.
### Configure Your Mod Settings
Launch the game and click the button labeled `Open AP Config` on the Title Screen.
In the menu that opens, fill in *Player*, *Hostname*, *Port*, and *Password* (if required) with the correct information for your room.
Launch the game, and using the menu on the Title Screen select `Archipelago` under `Randomizer Mode`.
Once you've input your information, click on Close. If everything was configured properly, you should see `Status: Connected!` and your chosen game options will be shown under `World Settings`.
Click the button labeled `Edit AP Config`, and fill in *Player*, *Hostname*, *Port*, and *Password* (if required) with the correct information for your room.
Once you've input your information, click the `Close` button. If everything was configured properly, you should see `Status: Connected!` and your chosen game options will be shown under `World Settings`.
An error message will display if the game fails to connect to the server.
Be sure to also look at the in-game options menu for a variety of additional settings, such as enemy randomization!
Be sure to also look at the in-game options menu for a variety of additional settings, such as enemy randomization!