Skip to content

Commit

Permalink
correct installation guide
Browse files Browse the repository at this point in the history
  • Loading branch information
Krzyhau authored Feb 22, 2024
1 parent 3b4dfbe commit fc9c00b
Showing 1 changed file with 5 additions and 6 deletions.
11 changes: 5 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,18 +10,17 @@ When patched into the FEZ instance, it can be used to dynamically load game modi

## Installing mod loader

1. Download [MonoMod](https://github.com/MonoMod/MonoMod/releases) (for .NET 4.5.2) and unpack it in the game's directory.
3. Download latest `FEZ.zip` from Release tab and unpack it in the game's directory (all contained DLL files should be in the same directory as `FEZ.exe`)
4. Run command `MonoMod.exe FEZ.exe` (or drag `FEZ.exe` onto `MonoMod.exe`). This should generate new executable file called `MONOMODDED_FEZ.exe`.
5. Run `MONOMODDED_FEZ.exe` and enjoy modding!
1. Download latest `FEZ.zip` from Release tab and unpack it in the game's directory.
2. Run `hat_install.bat` (for Windows) or `hat_install.sh` (for Linux). This should generate new executable file called `MONOMODDED_FEZ.exe`.
3. Run `MONOMODDED_FEZ.exe` and enjoy modding!

In the future, this process will be automated by a custom-made installer/mod manager (something like Olympus for Celeste's Everest).

## Adding mods

1. On first HAT launch, `Mods` directory should be created in the executable's directory. If not, create it.
2. Download the mod's archive and put it in this directory.
3. Start the game.
3. Start the game with `MONOMODDED_FEZ.exe` and enjoy your mod!

It's that simple!

Expand All @@ -31,7 +30,7 @@ It's that simple!
2. Edit `UserProperties.xml` to set up dependencies:

* Remove the property `UserPropertiesNotSetUp`.
* Set `FezDir` and `MonoModDir` to their respective directories. If you already have a FEZ installation with HAT, then these directories are probably all the same directory.
* Set `FezDir` to FEZ's directory (where FEZ.exe and other binaries are located).
* _Optional but recommended_: To prevent git from tracking your updated `UserProperties.xml`, run the command `git update-index --skip-worktree UserProperties.xml`.
* Additionally, change `CopyOverHATToFez` flag if you want to copy HAT binary and all its dependencies to the FEZ directory once built.

Expand Down

0 comments on commit fc9c00b

Please sign in to comment.