Building and Installing

Requirements:

• Premake 5 (pre-built executable available in this repository root)
• Visual Studio

Run the following command in the root of this directory to generate the project files (or simply launch premake5.bat):

premake5 vs2022

A project deploys its built .asi into the game folder its key names in a .env file in the repository root, so that the paths of a machine stay out of the repository (the file is ignored by git, a game the file does not name is simply not deployed), for example:

BULLY_SCHOLARSHIP_EDITION_DIR=Z:\Games\Bully Scholarship Edition

The build copies the plugin into the scripts folder of that game (plugins where the game has one), and starts the game from there when debugging. Only a plugin that is already installed is replaced. The keys of all projects are listed in the .env file of a working copy, where a key is the name of the game folder in upper case.

The usage is as simple as inserting the files into game's root directory. Uninstalling is as easy as that too, delete the files and you are done.

How to Report Crashes

If the game crashes while using the fixes, please send the crash dump (.dmp file).

⚙️ Easiest way (Recommended)

Plugins usually come with an Ultimate ASI Loader that is capable of generating crash dumps and crash logs.

1. Go to your game's main folder (where the game's .exe file is located).
2. In the same folder, create a new folder and name it exactly: CrashDumps

After the game crashes: - Open the CrashDumps folder you created. - Look for the newest file with the .dmp extension (this is the most important file). - You may also include the .log file if it exists, but the .dmp file is required.

Please send the .dmp file when reporting the crash.

You can report it here: - GitHub Issues

⚙️ Alternative way (Windows built-in crash dumps)

Use this method only if the previous method doesn't create a dump.

1. Press Windows key + R, type regedit, and press Enter.
2. Navigate to this path:
   HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\Windows Error Reporting
3. Right-click inside the Windows Error Reporting folder → New → Key, and name it exactly: LocalDumps
4. Close Registry Editor.

After a crash, the dump file will be saved here:
C:\Users\YOURUSERNAME\AppData\Local\CrashDumps

Find the newest .dmp file related to your game and send it in GitHub Issues.

Warning: This method requires administrator rights and enables crash dumps for all programs on your computer.

⚙️ If the game hangs or freezes (instead of crashing)

1. Press Ctrl + Shift + Esc to open Task Manager.
2. Find the game process in the list (usually the name of the game's .exe).
3. Right-click on it and select Create memory dump file.

Warning: This file will be quite large (hundreds of MB or more).

Upload the .dmp file to Google Drive, OneDrive, Dropbox, or any similar service and make sure the link is set to public access. Then share the link when reporting in GitHub Issues.

Important notes

• Not compatible with Windows XP (without recompiling with _xp toolset and /Zc:threadSafeInit-).
• For using with WINE, follow this guide.