Skip to content

Document config and menu key #51

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Fexty12573 merged 3 commits into from
Sep 21, 2025
Merged

Document config and menu key #51

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7d17f0e
Remove outdated link anchor
jn64 Jan 19, 2025
859b150
Document config and menu key
jn64 Jan 19, 2025
7b5b337
Simplify Linux install instructions
jn64 Sep 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 13 additions & 11 deletions docs/Install/Installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,22 +6,17 @@ Grab the x64 Desktop Runtime and install it.
Once you have the .NET runtime installed you can grab the latest release from the [Releases Page](https://github.com/Fexty12573/SharpPluginLoader/releases).
Extract the contents of the archive into the game's root directory (where `MonsterHunterWorld.exe` is located).

If you installed everything correctly you should now find `winmm.dll` in the same folder as `MonsterHunterWorld.exe`, and a `CSharp` directory in `nativePC\plugins`.
If you installed everything correctly you should now find `winmm.dll` in the same directory as `MonsterHunterWorld.exe`, and a `CSharp` directory in `nativePC\plugins`.

## Linux (Proton/Wine)
As of version 0.0.7.2, SPL officially supports Linux through Proton/Wine. Below are the steps to install and run SPL on Linux.

1. Download the latest **.NET Desktop Runtime** for x64 from [here](https://dotnet.microsoft.com/en-us/download/dotnet/8.0#runtime-desktop-8.0.10).
2. Install the downloaded installer using [protontricks](https://github.com/Matoking/protontricks):
1. Install .NET Desktop Runtime 8.0 and Direct 3D Shader Compiler using [protontricks](https://github.com/Matoking/protontricks):
```bash
protontricks-launch --appid 582010 path/to/windowsdesktop-runtime-8.x.xx-win-x64.exe
protontricks 582010 dotnetdesktop8 d3dcompiler_47
```
3. Install the Direct 3D Shader Compiler using protontricks:
```bash
protontricks 582010 d3dcompiler_47
```
4. Download the latest linux release of SPL (`SharpPluginLoader-<version>-linux.zip`) from the [Releases Page](https://github.com/Fexty12573/SharpPluginLoader/releases) and extract it into the game's root directory. After doing so you should have a `msvcrt.dll` file in the same folder as `MonsterHunterWorld.exe`.
5. Set the steam launch options for MHW as follows:
2. Download the latest linux release of SPL (`SharpPluginLoader-<version>-linux.zip`) from the [Releases Page](https://github.com/Fexty12573/SharpPluginLoader/releases) and extract it into the game's root directory. After doing so you should have a `msvcrt.dll` file in the same directory as `MonsterHunterWorld.exe`.
3. Set the steam launch options for MHW as follows:
```bash
# Use this for SPL only
WINEDLLOVERRIDES="msvcrt=n,b" %command%
Expand All @@ -31,6 +26,13 @@ WINEDLLOVERRIDES="msvcrt,dinput8=n,b" %command%
```

## Usage
### Config
SPL configuration is stored in `loader-config.json` in the same directory as `MonsterHunterWorld.exe`. It will be automatically generated when using SPL.

### Menu
Press `F9` to access the SPL menu in-game. Plugins may add various UI in this menu.

### Plugins
Any C# plugins will be placed directly into the `CSharp` directory. The plugin loader will automatically load all DLLs in this directory.
Subdirectories are also supported, so you can organize your plugins however you want.

Expand All @@ -41,7 +43,7 @@ Subdirectories are also supported, so you can organize your plugins however you
Once you have all your plugins installed you can simply start the game. The plugin loader will automatically load all plugins.
Depending on the plugins you have installed you might also see an overlay/UI appear on the screen.

## Directory Structure Examples
### Directory Structure Examples
```
<Root game directory>
└── winmm.dll/msvcrt.dll
Expand Down
Loading