bepinex / bepinex-docs

Documentation and API pages for BepInEx

BepInEx Documentation

This is the repo for storing documentation related to BepInEx.

View the docs

Contributing

All contributions either via PRs or issues are welcome!

This project uses DocFX to render the API documentation and the articles.
Please refer to DocFX documentation for information on using DocFX-flavoured markdown.

In general, you should be able to update pages with a simple markdown editor.

Testing docs locally

If you want to preview the docs locally, you need .NET 5 or newer installed.
After that, do the following:

1. Clone this repo with git clone
2. In the cloned directory, run

   git worktree add --checkout common common
   

   A folder named common should appear.
3. Write documentation into api or articles folder. Refer to docfx guide and DFM syntax guide for info on writing the guides using DocFX
4. Run common/build.bat --target=Build to build the docs. The generated docs will appear in _site folder

bepinex-docs's Issues

plugins_dnSpy is outdated, no mention of dnSpyEx and moved debug mono dlls

minor spelling error in index.md

for linux, it says "designation nix" where it should be unix

Contents list on the right only shows some heading levels

Example https://docs.bepinex.dev/articles/advanced/steam_interop.html
Only the second level of headings is shown, completely obscuring the fact that there's a proton section below.

Launch instructions for Steam Deck don't seem to work

I've been trying to add Bepinex to my instance of Graveyard Keeper on my Steam Deck. I followed the guide on the wiki, and used the advanced steam launch instructions, ./run_bepinex.sh %command%. Albiet this does not launch the modded version of the game for me, and I could only get it to launch via manual execution.

After scouring the web for a little bit, I came upon a post on reddit detailing how to get it to run. The relevant details are here:

There is one thing you have to do slightly different for steamdeck, in the launch options insetad of the command on the BepinExPack Valheim instrustions section, use:

./start_game_bepinex.sh || %command%

I found this out because their default command would just crash the second you tried to launch the game. After some research and trial/error I realized you need %command% otherwise steam assumes its the first argument, thus never getting to the shell script meaning it wont launch with BepInEx but it will launch just vanilla. Using the OR command above it first tries the shell script OR the base command to launch the game. Between the default linux install instructions and this updated launch arugment command, Valheim on my steam deck is now modded and working great!

Could this be added to the docs so other users don't have issues with this? I can provide confirmation that it works on my deck if required.

BepInEx 5.4.21 documentation references new 'VersionRange' for BepInDependency that isn't available in 5.x

The documentation for using BepInDependency when creating new plugins on 5.4.21 located here:
https://docs.bepinex.dev/articles/dev_guide/plugin_tutorial/2_plugin_start.html#specifying-dependencies-on-other-plugins

References using a VersionRange, as opposed to the actual string MinimumVersion parameter that is required for this attribute. The API documentation for 5.4.21 has the correct attribute parameters listed:
https://docs.bepinex.dev/api/BepInEx.BepInDependency.html

Easy and fast alternative to protontricks.

Protontricks is not working for some users due to an issue with wow64 wine. Luckily there is a faster and simpler way to to the dll override for proton without using protontricks or even winecfg. In the steam launch options of the relevant game, simply put
WINEDLLOVERRIDES="winhttp.dll=n,b" %command%

source: Vampire Hunter D on protondb: https://www.protondb.com/app/1966720

I can personally confirm that this fixes bepinex for Lethal Company proton without installing any additional software. Note that the bepinex terminal doesn't launch for me so it might not seem like it's working for you.