From 7d17f0e9ac14324c1cbb62fa03edaf42c3d50e1e Mon Sep 17 00:00:00 2001 From: jn64 <23169302+jn64@users.noreply.github.com> Date: Sun, 19 Jan 2025 15:14:16 +0800 Subject: [PATCH 1/3] Remove outdated link anchor Unfortunately there is no version-agnostic or "latest" anchor. --- docs/Install/Installation.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/Install/Installation.md b/docs/Install/Installation.md index c1b0e3b..2d25466 100644 --- a/docs/Install/Installation.md +++ b/docs/Install/Installation.md @@ -11,7 +11,7 @@ If you installed everything correctly you should now find `winmm.dll` in the sam ## 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). +1. Download the latest [**.NET Desktop Runtime** for x64](https://dotnet.microsoft.com/en-us/download/dotnet/8.0). 2. Install the downloaded installer using [protontricks](https://github.com/Matoking/protontricks): ```bash protontricks-launch --appid 582010 path/to/windowsdesktop-runtime-8.x.xx-win-x64.exe From 859b150674f5f68a79f6283f28787c1461e35491 Mon Sep 17 00:00:00 2001 From: jn64 <23169302+jn64@users.noreply.github.com> Date: Sun, 19 Jan 2025 18:00:08 +0800 Subject: [PATCH 2/3] Document config and menu key Questions about these SPL features are often directed to plugin authors. Also change 2 uses of "folder" to "directory" which was already used 11 times. --- docs/Install/Installation.md | 13 ++++++++++--- 1 file changed, 10 insertions(+), 3 deletions(-) diff --git a/docs/Install/Installation.md b/docs/Install/Installation.md index 2d25466..8a41a90 100644 --- a/docs/Install/Installation.md +++ b/docs/Install/Installation.md @@ -6,7 +6,7 @@ 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. @@ -20,7 +20,7 @@ protontricks-launch --appid 582010 path/to/windowsdesktop-runtime-8.x.xx-win-x64 ```bash protontricks 582010 d3dcompiler_47 ``` -4. Download the latest linux release of SPL (`SharpPluginLoader--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`. +4. Download the latest linux release of SPL (`SharpPluginLoader--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`. 5. Set the steam launch options for MHW as follows: ```bash # Use this for SPL only @@ -31,6 +31,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. @@ -41,7 +48,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 ``` └── winmm.dll/msvcrt.dll From 7b5b3377fc1a0ffb5140aa7f83443eed35e2d280 Mon Sep 17 00:00:00 2001 From: Justin Koh Date: Thu, 18 Sep 2025 23:25:14 +0800 Subject: [PATCH 3/3] Simplify Linux install instructions --- docs/Install/Installation.md | 13 ++++--------- 1 file changed, 4 insertions(+), 9 deletions(-) diff --git a/docs/Install/Installation.md b/docs/Install/Installation.md index 8a41a90..2c0fb89 100644 --- a/docs/Install/Installation.md +++ b/docs/Install/Installation.md @@ -11,17 +11,12 @@ If you installed everything correctly you should now find `winmm.dll` in the sam ## 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](https://dotnet.microsoft.com/en-us/download/dotnet/8.0). -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--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`. -5. Set the steam launch options for MHW as follows: +2. Download the latest linux release of SPL (`SharpPluginLoader--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%