SharpPluginLoader

A C# plugin loader for Monster Hunter World based on .NET 8.0.

For more detailed documentation and tutorials, visit the wiki.

How to use

1. Install .NET 8.0 (Get the .NET Desktop Runtime 8.0.x)
2. Download the latest release from the releases page and extract it into your Monster Hunter World directory.

Plugin Development

For more detailed instructions visit the wiki.

1. Install the Visual Studio 2022 17.8 Preview 2 or later.
2. Create a new .NET 8.0 class library project and add a reference to the SharpPluginLoader.Core NuGet package.
3. Create a class that implements the SharpPluginLoader.Core.IPlugin interface.
4. Put the compiled assembly into nativePC/plugins/CSharp. Assemblies are also allowed to be in subdirectories.

Framework Development (with Visual Studio 2022)

1. Clone the repository with submodules:
   1. git clone --recursive git@github.com:Fexty12573/SharpPluginLoader.git
2. Setup vcpkg IDE integration if you haven't already done so:
   1. Open Developer PowerShell for Visual Studio
   2. Run vcpkg integrate install
3. Generate cimgui VS project:
   1. Open Developer PowerShell for Visual Studio
   2. cd SharpPluginLoader\dependencies\cimgui\
   3. cmake -B . -G 'Visual Studio 17 2022'
4. Open mhw-cs-plugin-loader.slnx
5. Build solution Build -> Build Solution

Building Releases

To create release packages you can use the make-package.py script. It will build everything and package it into a ready to use zip.

make-package.py [-h] [-c {Release,Debug}] [-m] sln_dir tag

Create a release of the plugin loader

positional arguments:
  sln_dir               The directory of the solution
  tag                   The tag to use for the release in the format x.x.x[.x]

options:
  -h, --help            show this help message and exit
  -c {Release,Debug}, --config {Release,Debug}
                        The configuration to build
  -m, --msbuild-in-path
                        Set if msbuild is in the PATH environment variable

Example invocation: python make-package.py -c Release -m ./ 0.1.0

Enabling C# Debugging

1. Make sure all projects are compiled in Debug mode.
2. Open the mhw-cs-plugin-loader project properties, make sure the Debug configuration is selected and go to General > Debugging. Here set the Debugger Type to Mixed (.NET Core).
3. In the Attach to Process dialog, make sure Managed (.NET Core, .NET 5+) and Native are selected.

Contributing

If you would like to contribute, feel free to fork the repository and make a PR. If you would like to join the core development team you can contact me on Discord @fexty.

Libraries Used

• safetyhook - Native hooking library
• Reloaded.Hooks - Managed hooking library
• cimgui - C wrapper for Dear ImGui
• Dear ImGui - GUI library
• ImGui.NET - C# wrapper for Dear ImGui
• tinyobjloader - Wavefront OBJ loader
• nlohmann-json - C++ JSON library
• zlib - Compression library
• DirectXMath - DirectX Math library
• PicoSHA2 - header-only SHA256 library
• DirectXTK[12] - DirectX Toolkit, used for loading and managing textures

Credits

• Lyra: Creating the logo
• ImDevinC: Lots of testing and feedback to get Linux support working
• jn64: Writing the complete Linux installation instructions
• Ando: Writing the preloader and generally improving the native side