HAT - Simple mod loader for FEZ

Overview

HAT is a MonoMod-based mod loader for FEZ, currently in development. Its main purpose is to make process of FEZ modding slightly easier for end user.

When patched into the FEZ instance, it can be used to dynamically load game modifications on the game launch. Correctly prepared mods can add/override game assets or inject its own logic through custom-made plugin.

Installing mod loader

1. Download the installer for your platform from the Releases page.

Platform	File
Windows	HATinstaller-win-x64.exe
Linux	HATinstaller-linux-x64
macOS	HATinstaller-osx-x64

2. Run the installer. FEZ will be detected automatically from your Steam or GOG library. If detection fails, drop the installer into your FEZ game folder and run it from there, or use --path <dir>.

3. Launch FEZ from Steam or GOG, or run FEZ.exe (Windows) or ./FEZ (Linux/macOS) directly, and enjoy modding!

Adding mods

1. On first HAT launch, Mods directory will be created in the executable's directory.
2. Download the mod's archive and put or extract it in this directory.
3. Start FEZ and enjoy your mod!

It's that simple!

Building HAT

Install the .NET 10 SDK and clone the repository with its MonoMod submodule:

git clone git@github.com/FEZModding/HAT.git --recursive

For an existing local repository, run:

git submodule update --init --recursive

To build the plugin binaries on their own:

dotnet build Plugin/FEZ.HAT.mm.csproj -c Release

This produces the plugin binaries in Plugin/bin/Release/. To build a standalone installer that packages and embeds those binaries, publish for your platform's runtime ID:

dotnet publish Installer/FEZ.HAT.Installer.csproj -c Release -r linux-x64 -o artifacts/installer-publish

Use win-x64 on Windows or osx-x64 on an Intel Mac in place of linux-x64.

"Documentation"

• Create your own HAT modifications
• Additional HAT behaviour

Mods created for HAT

• FEZUG - a power tool for speedrun practicing and messing with the game
• FezSonezSkin - mod replacing Gomez skin with Sonic-like guy seen in Speedrun Mode thumbnail
• FezMultiplayerMod - mod adding multiplayer functionalities to FEZ