Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/measurity/modtemplatevalheim
Valheim template for quickly writing mods using BepInEx
https://github.com/measurity/modtemplatevalheim
bepinex modding valheim-mod
Last synced: 2 months ago
JSON representation
Valheim template for quickly writing mods using BepInEx
- Host: GitHub
- URL: https://github.com/measurity/modtemplatevalheim
- Owner: Measurity
- License: mit
- Created: 2021-02-12T20:47:02.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2024-10-02T22:11:20.000Z (3 months ago)
- Last Synced: 2024-10-11T10:11:52.292Z (3 months ago)
- Topics: bepinex, modding, valheim-mod
- Language: C#
- Homepage:
- Size: 117 KB
- Stars: 13
- Watchers: 2
- Forks: 4
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ModTemplateValheim
Template mod for Valheim using Bepinex. Works for Steam on either Windows or Linux systems.
Everything required is **automatically installed into Valheim**:
- BepInEx (Unstripped UnityEngine dlls too) + HarmonyX
- Publicizes dlls from game as project dependencies
- Moves your mod into the BepInEx plugins folder.
## How to use template
1. Download or clone this repository then open in Visual Studio or JetBrains Rider.
2. (optional) Rename the `ExampleCallMethodMod.csproj` to your mod name.
3. Rebuild the solution.
4. If there are errors, restart your IDE.
5. Play Valheim to test your mod!
Any project in this solution that ends with `Mod` will automatically install itself into Valheim and reference the game code.
## Requirements
- [MSBuild 16+](https://visualstudio.microsoft.com/downloads/#build-tools-for-visual-studio-2022) (also installed with Visual Studio)
- If you want modern C# lang support you need https://dotnet.microsoft.com/en-us/download as well. See Directory.Build.props file to change language version.
## Troubleshooting
- **Missing dependencies**
- Run rebuild again
- **Code is red - IntelliSense broken**
- Restart your IDE
## I want to..
- **Rename my mod**
Add (or change) the `AssemblyName` property to the mod's .csproj file. Note to run `clean` on this solution beforehand to uninstall your mods. Example:
```xml
My cool mod name
```
- **Change mod author or version**
Add (or change) the `Authors` property to the mod's .csproj file. Example:
```xml
Measurity;geocine;eai04191
My cool mod - the second
1.0.0.1
```
Which will generate the BepInEx plugin metadata as:
```cs
public const string PluginAuthor = "Measurity & geocine & eai04191";
public const string PluginGuid = "com.github.measurity.Mycoolmodthesecond";
public const string PluginName = "My cool mod - the second";
public const string PluginVersion = "1.0.0.1";
```
## Credits
https://github.com/MrPurple6411 - First to make a proper template. Used their declared project dependencies as a base.
https://github.com/sebastienvercammen - Providing help with overriding game DLLs with unstripped DLLs through UnityDoorstop.
https://github.com/js6pak - Primary author of BepInEx.AssemblyPublicizer.MSBuild which was a big help in figuring out MSBuild tasks.
And thanks to all contributors!