Skip to content

Commit

Permalink
Modding setup upkeep (#36)
Browse files Browse the repository at this point in the history
* fix dnspy link

* Add .NET 8 sdk warning
  • Loading branch information
legoandmars authored Dec 18, 2023
1 parent 7b2f3c7 commit 41de3c5
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 1 deletion.
2 changes: 1 addition & 1 deletion docs/modding/initial-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ Enabled = true
A decompiler allows you to decompile an existing program. This is technical terminology that can roughly be translated to "it allows you to peek behind the curtain and see what the code of a program looks like". Why is this important, you may ask? Well, if we're going to mod a game, we first need to know *what* to mod. Do we want to reduce the price of items? We'll need to know in what part of the code items are displayed and sold to the player. Do we want to add a weather condition? We'll need to know in what parts of the code the game handles and spawns weather.

We recommend one (or all) of three free options:
- [dnSpy](https://github.com/dnSpy/dnSpy)
- [dnSpyEx](https://github.com/dnSpyEx/dnSpy)
- [ILSpy](https://github.com/icsharpcode/ILSpy)
- [dotPeek](https://www.jetbrains.com/decompiler/)

Expand Down
9 changes: 9 additions & 0 deletions docs/modding/starting-a-mod.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,15 @@ Alternatively, you can open a console and run the following command, assuming yo
dotnet new bepinex5plugin -n MyFirstPlugin -T "netstandard2.1" -U "2022.3.9"
```

::: warning
Some people have been [reporting problems](https://github.com/BepInEx/BepInEx.Templates/issues/8) creating new BepInEx plugins from the template when using the .NET 8 SDK:

`Failed to create template.
Details: Object reference not set to an instance of an object.`

If you get this error, try downgrading to the [.NET 7 SDK](https://dotnet.microsoft.com/en-us/download/dotnet/7.0).
:::

### Organising your modding projects

We recommend creating a folder somewhere easily accessible that will store all of your future modding projects. Something like "LethalCompanyMods". Move the newly created folder for your mod into this folder, to keep things well-organised.
Expand Down

0 comments on commit 41de3c5

Please sign in to comment.