Skip to content

Commit b365a44

Browse files
authored
Merge pull request #286 from aliosgaming/master
Update Front Page and Setup Guides
2 parents 24dc58c + 50be509 commit b365a44

15 files changed

+126
-38
lines changed

docs/index.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@ title: Home
44

55
<p align="center"><img src="assets/image/randomizer-header.png" alt="Randomizer Logo" /></p>
66

7-
## As of the update on 6/13/2024, the Epic Games Store version of randomizer is not compatible with the existing tools. Same can be said for the new Steam release. Please be patient as the developers update the tools to bring compatibility back. For more information, please head to the discord.
8-
97
Kingdom Hearts 2 Randomizer takes items from their normal game locations and places them in random locations. Logic is
108
used to ensure all necessary items are obtainable.
119

@@ -24,11 +22,14 @@ See the various pages on this site for additional information about the randomiz
2422
* [Troubleshooting](troubleshooting/index.md)
2523
* [Glossary](glossary/index.md)
2624

27-
### First-Time Setup
25+
### First-Time Setup Tutorials
2826

29-
* [PC (Epic Games)](setup/Panacea-ModLoader/index.md) by Alios
27+
* [PC (Epic/Steam)](setup/Panacea-ModLoader/index.md) by Alios
3028
* [Emulator (PCSX2)](setup/pcsx2-ex-setup/pcsx2-ex-setup.md) by gameaddict
3129

30+
### Updating Your Installation
31+
* [Epic Update Guide Post Steam Release](setup/updating/index.md) by Alios
32+
3233
### Resources
3334

3435
* [Downloads](downloads/index.md)
29.9 KB
Loading
24 KB
Loading
19.6 KB
Loading

docs/setup/Panacea-ModLoader/index.md

Lines changed: 44 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
# PC New Setup Guide
1+
# PC - Steam and Epic Setup Guide
22

33
* [Heads up!](#heads-up)
4-
* [Downloads](#resources-needed)
4+
* [Downloads](#downloads)
55
* [Installing the Mods Manager & Seed Generator](#installing-openkh-mods-manager-and-seed-generator)
66
* [Setting up the Mods Manager](#setting-up-openkh-mods-manager)
77
* [Installing the GoA mod](#garden-of-assemblage-mod-installation)
@@ -11,61 +11,70 @@
1111
## Heads up!
1212
* Feel free to go to the [Discord server](https://discord.gg/vKhdwNAmzE) for help with the setup, there is a dedicated #help channel where you can find people to assist you if you're facing any difficulties. (P.S. Please be polite)
1313
* `You must run the game once` before you start the guide. Otherwise it may not boot up correctly after the randomizer is installed.
14-
* `VERIFY GAME FILES` through the Epic Games Launcher for Kingdom Hearts 1.5 + 2.5 Remix (v1.0.0.8_WW), they need to be clean/unpatched files for the extraction process to work.
15-
* If you have EVER installed the KH2 Randomizer before then please check your `C:\Documents\KINGDOM HEARTS HD 1.5+2.5 ReMIX\scripts\kh2 folder` (if you have one) and EMPTY IT.
16-
* Unofficial copies of the game are not supported, it is strongly recommended you buy and install the game directly from the Epic Games Store.
14+
* `VERIFY GAME FILES` through Steam/Epic for Kingdom Hearts 1.5 + 2.5 Remix (v1.0.0.9_WW), they need to be clean/unpatched files for the extraction process to work.
15+
* If you have EVER installed the KH2 Randomizer before then please check if you have a folder at `C:\Documents\My Games\KINGDOM HEARTS HD 1.5+2.5 ReMIX\scripts\kh2` (for Steam) or `C:\Documents\KINGDOM HEARTS HD 1.5+2.5 ReMIX\scripts\kh2 folder` (for Epic) and EMPTY IT. You may have outdated lua files located there.
16+
* Unofficial copies of the game are not supported. It is strongly recommended you buy and install the game directly from either the Steam or Epic Games stores.
1717

18-
## Resources Needed:
18+
## Downloads:
1919
* [OpenKH Mods Manager](https://github.com/aliosgaming/OpenKh/releases/latest/download/OpenKH.Mod.Manager.zip)
20+
- The program you will be downloading and installing mods to. It can directly download mods hosted on github, as well as locally downloaded mods with the `lua`, `.zip`, and `.kh2pcpatch` file types (other KH game .pcpatch files are also supported)
2021
* [Seed Generator](https://github.com/tommadness/KH2Randomizer/releases/latest/download/KH2.Randomizer.exe)
21-
* [.NET6 Desktop Runtime](https://download.visualstudio.microsoft.com/download/pr/52d6ef78-d4ec-4713-9e01-eb8e77276381/e58f307cda1df61e930209b13ecb47a4/windowsdesktop-runtime-6.0.25-win-x64.exe
22-
)
22+
- The program that generates KH2 Randomizer seeds. In the app you can see detailed descriptions about each setting by hovering over them with your mouse, or you can read more about them on the "Settings" page [here](https://tommadness.github.io/KH2Randomizer/settings/)
23+
* [.NET6 Desktop Runtime](https://download.visualstudio.microsoft.com/download/pr/a1da19dc-d781-4981-84e9-ffa0c05e00e9/46f3cd2015c27a0e93d7c102a711577e/windowsdesktop-runtime-6.0.31-win-x64.exe)
24+
- Software required to run the OpenKH Mods Manager
2325

2426
## Installing OpenKH Mods Manager and Seed Generator
25-
1. Install .NET6 Runtime by running the `windowsdesktop-runtime-6.0.25-win-x64.exe` executable you just downloaded
26-
2. Create a KH2 Rando folder on the same hard drive you have the game installed (this is where you will install all your randomizer tools)
27+
1. Start by downloading the 3 programs from the download links above
28+
2. Install .NET6 Runtime by running the `windowsdesktop-runtime-6.0.25-win-x64.exe` executable you just downloaded
29+
3. Create a `KH2 Rando` folder (you may give it any name) on the same hard drive you have the game installed. This is where we will be installing the `Mods Manager` and `Seed Generator`
2730

2831
![First Warning](../images/Panacea-ModLoader/First_warning.png)
2932

30-
3. Extract OpenKH Mods Manager to this new folder
33+
4. Extract the `OpenKH Mods Manager` to the "KH2 Rando" folder
3134
- It's recommended to give each app its own subfolder to make navigating their files easier (See screenshot)
35+
5. Place the `Seed Generator` exe into its own "Seed Generator" folder in the "KH2 Rando" folder. When we run the Seed Generator for the first time later in this guide, it will place a few new files and folders into its directory and we don't want to get them mixed up with our other stuff
3236

3337
![Rando Folder](../images/Panacea-ModLoader/KH2%20Rando%20Folder.png)
3438

3539
## Setting Up OpenKH Mods Manager:
36-
1. Run the `OpenKh.Tools.ModsManager.exe` in the OpenKH folder
40+
1. Find and run the `OpenKh.Tools.ModsManager.exe` from inside the OpenKH installation folder
3741
- The Setup Wizard will open automatically, click `Next` to start
38-
2. Change game edition to `PC Release Via Epic Games Store`
39-
3. Then click the folder icon and navigate to your KH1.5_2.5 installation folder (The default is `C:\Program Files\Epic Games\KH_1.5_2.5` but this may differ from your own)
40-
4. Once your game folder is chosen, click `Next`
4142

42-
![Setup Wizard-Game Edition](../images/Panacea-ModLoader/Game%20Edition%20Window.png)
43+
![Wizard Differences](Wizard_Settings_Warning.png)
4344

44-
5. Click the `Install Panacea for Windows` Button. This will install the mod loader to your game installation folder. Then click `Next`
45-
- If you want to verify it was added successfully, check your game's install folder for a file called `DBGHELP.DLL` and a folder called `Dependencies`
45+
2. Click on the `Game Edition` drop-down menu and select `PC Release`
46+
3. In the next drop-down menu, choose `Epic Games Store` as your launcher (or `Steam` if you have the Steam version)
47+
4. Once you have selected the launcher, click on the `Detect Installations` button to have the wizard automatically locate your game install folders (KH 2.8 is also supported by the Mods Manager but is not required to complete the setup)
48+
* If the wizard fails to automatically detect your game install folder you will need to manually navigate to it by clicking the folder icon on the right of the input line
49+
5. Once your game folder is found, click `Next`
50+
51+
![Setup Wizard-Game Edition](../updating/Setup_Wizard_Page_2.png)
4652

47-
![Panacea Wizard Window](../images/Panacea-ModLoader/Panacea%20Install%20Window.png)
53+
6. On the `Panacea` installation page, first set the `Game Collection` drop-down menu to `KINGDOM HEARTS 1.5 + 2.5 ReMIX`
54+
7. Then, click the `Install Panacea for Windows` button. This will install `Panacea` (a real time mod loader) to your game installation folder. Then click `Next`
55+
- If you want to verify it was added successfully, check your game's install folder for a file called `DBGHELP.DLL` and a folder called `Dependencies`
4856

49-
6. You will also need to install LuaBackend to play the randomizer. Enable the `KH2` option for now and then click `Install and Configure Lua Backend`
50-
- You may re-run the setup wizard at any time to add support for the other games as well.
51-
7. Once the LuaBackend install is complete click `Next`
57+
![Panacea Wizard Window](../updating/Setup_Wizard_Page_3.png)
5258

53-
![LuaBackend Install Window](../images/Panacea-ModLoader/Install%20Lua%20Backend.png)
59+
8. On the `Install LuaBackend` page, verify the `Game Collection` is set to `KINGDOM HEARTS 1.5 + 2.5 ReMIX`
60+
9. Then enable the `KH2` check box and click `Install and Configure Lua Backend`
61+
- You may enable the other games now if you want, or re-run the setup wizard at any time to add support for the rest in the future.
62+
10. Once the LuaBackend install is complete click `Next`
5463

55-
8. The Mods Manager can launch KH2 itself by enabling the `Launch Via Epic Games` option. This option can save you time and a few clicks whenever you want to run the game after changing your mods or seed. It's recommended to enable this but is not required.
64+
![LuaBackend Install Window](Setup_Wizard_Lua_Backend.png)
5665

57-
![Launch Via Epic Games](../images/Panacea-ModLoader/Launch%20Via%20Epic%20Games.png)
66+
![Extraction Note](Extraction_Note.png)
5867

59-
9. The Mods Manager now has the option to extract multiple games from the KH1.5_2.5 collection. For the purposes of this guide you only need to extract KH2, but feel free to extract the others as well if you plan on modding those games, or for including their music in the seed generators "music rando" option. Leave the extraction location as default, then press the `Extract Game Data` button to begin extraction. It usually takes 5-15 minutes (for KH2 alone) depending on your hardware so please be patient.
68+
12. Leave the extraction location as default, then press the `Extract Game Data` button to begin. The upscaled textures have increased the time needed to extract all of the game files. It may take anywhere from 15-30 minutes to fully extract KH2 so please be patient. The progress bar *may* sit around the 75% mark for a few minutes so make sure to wait for the page to say the extraction is done before continuing.
6069

61-
![Extraction Window](../images/Panacea-ModLoader/Extraction%20Window.png)
70+
![Extraction Window](../updating/Setup_Wizard_Page_5.png)
6271

63-
10. Once the extraction is complete, click on `Next` and on the next window click `Finish`. You have successfully installed the Mods Manager!
72+
11. Once the extraction is complete, click on `Next` and on the final window click `Finish`. You have successfully installed the Mods Manager!
6473

6574
## Garden of Assemblage Mod Installation:
6675
Installing new mods into the Mods Manager is easy! Follow these steps to get the main Garden of Assemblage mod installed:
6776

68-
1. Be sure the game selected in the top right of the main window shows `Kingdom Hearts 2`
77+
1. Be sure the game selected in the top right of the Mods Manager main window shows `Kingdom Hearts 2`
6978
2. Next, Click `Mods` in the top left drop down menu, and then click `Install a new mod`
7079

7180
![Install New Mod](../images/Panacea-ModLoader/Install%20New%20Mod.png)
@@ -86,27 +95,28 @@ Installing new mods into the Mods Manager is easy! Follow these steps to get the
8695
![Second Warning](../images/Panacea-ModLoader/Second_warning.png)
8796

8897
## Installing a new seed to play:
89-
1. Choose your seed settings in the generator window and then click on `Generate Seed` in the bottom right.
98+
1. Open the Seed Generator app by double clicking the `KH2.Randomizer.exe` program you downloaded earlier. If this is your first time starting the program, it may take some time to open as it extracts the necessary folders and files it uses to run.
99+
2. Choose your seed settings in the generator window, or choose one of the built in presets under the `Preset` tab (I recommend the "StarterSettings" preset) and then click on `Generate Seed` in the bottom right
90100

91101
![Generate Seed](../images/Panacea-ModLoader/Generate%20New%20Seed.png)
92102

93103
![Third Warning](../images/Panacea-ModLoader/Third_warning.png)
94104

95105
3. This will open up a window to save the seed as a zip file. Save it anywhere that works for you (I like to place it in the same folder as the generator)
96-
4. Once saved, open up the Mods Manager and click on `Mods`, then `Install a New Mod`
106+
4. Once saved, return to the Mods Manager and click on `Mods`, then `Install a New Mod`
97107
5. This time click on `Select and Install Mod Archive or Lua Script`, navigate to your new seed zip file and click `Open`
98108

99109
![Install New Seed](../images/Panacea-ModLoader/Install%20New%20Seed.png)
100110

101111
![Target New Seed](../images/Panacea-ModLoader/Target%20New%20Seed.png)
102112

103-
6. Be sure to click on the check box next to the seed, then click on `Build` and `Build and Run` to enable the mod in game. Note the 5 buttons to the right of the mod list. The first button places a mod at the top of the list. The second moves a mod up the list one space, the third moves it down the list by one space. The green '+' icon is a shortcut to install a new mod, while the red "-" icon is a shortcut to deleting a mod
113+
![Fourth Warning](../images/Panacea-ModLoader/Fourth_warning.png)
114+
115+
7. Be sure to click on the check box next to the seed, then click on `Build` and `Build and Run` to enable the mod in game. Note the 5 buttons to the right of the mod list. The first button places a mod at the top of the list. The second moves a mod up the list one space, the third moves it down the list by one space. The green '+' icon is a shortcut to install a new mod, while the red "-" icon is a shortcut to deleting a mod
104116
- `How to install a new seed in the future:` Create a new zip seed file using the generator. Delete the current seed from your Mods Manager. Add the new zip seed to your Mods Manager. Enable the seed and then `Build and Run`
105117

106118
![Enable New Seed](../images/Panacea-ModLoader/Enable%20New%20Seed.png)
107119

108-
![Fourth Warning](../images/Panacea-ModLoader/Fourth_warning.png)
109-
110120
![Tip](../images/Panacea-ModLoader/Tip.png)
111121
* `KH2FM-Mods-equations19/auto-save` - This mod auto saves the game for you as you enter rooms. Be sure to make at least 1 regular save in game, then if you ever crash or your game closes unexpectedly, just hold the `SELECT` button while loading a save, and the auto-save will be loaded instead.
112122
* `KH2FM-Mods-equations19/soft-reset` - Hold `L1+L2+R1+R2+Start` at the same time to immediately reset the game to the start screen. Very useful if you accidentally softlock in boss/enemy rando, or just to restart the game faster!
8.89 KB
Loading

docs/setup/updating/Goa_Update.png

46.7 KB
Loading
4.98 KB
Loading
14.9 KB
Loading
26.1 KB
Loading

0 commit comments

Comments
 (0)