Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding BepInEx repository info #23

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions documentation/getting_started/making_mods/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,6 +66,8 @@ To get started with custom code for Timberborn mods, follow these steps:
1. Create a new .net standard 2.1 code project
1. Add the nuget package `TimberAPI`. [Visual studio guide](https://docs.microsoft.com/en-us/nuget/quickstart/install-and-use-a-package-in-visual-studio), [Rider guide](https://www.jetbrains.com/help/rider/Using_NuGet.html)

`TimberAPI` depends on the bepinex nuget package repository. You might need to add this as a source `https://nuget.bepinex.dev/v3/index.json`.

To bind your custom classes to Timberborn's dependency container create a class that inherits the `IConfigurator` interface. Then using the `Configure()` method you can bind
the classes. The Configurator class will laso need an `[Configurator]` attribute, so TimberAPI knows where the Configurator is used. See [Dependency injection](/../dependency_injection/)

Expand Down