Modapi The Forest Mods

Mods I've created for ModAPI for TheForest. Blocks attacking when the game is out of focus and you focus it again with a left click. This is only usefull when you have two monitors and play the game on windowed mode. In collaboration with Souldrinker, we proudly present a map mod for the ModAPI! Can be opened and closed with a key (standard: M). Drag the mouse to move the map. Use the mouse scroll wheel to zoom the map. Forest & Cave map; Filter markers; Displays your current location; Download ModAPI & Map Mod How to install it.

This site uses cookies. By continuing to browse this site, you are agreeing to our use of cookies. More details

Your browser has JavaScript disabled. If you would like to use all features of this site, it is mandatory to enable JavaScript.

Feedback and suggestions
Here you can post feedback or suggestions to make the ModAPI even better.
Threads
45
Posts
883
- Threads
  40
  Posts
  267
Let's plays and videos
Here you can share your videos of the mod api with the others.
Images & Screenshots
Here you can share your images and screenshots of the forest.
Released mods
Here you can find mods for the ModAPI of 'The Forest'.
Threads
92
Posts
282
Talk
Here you can discuss about the game 'The Forest'.
hfy962464 -

Generic Unity games + Basic ModAPI usage

Getting started

Write your own mod with this tutorial. Basic C# knowledge would be an advantage. Unity knowledge is also good.

In this tutorial we want to change the ingame day by using the GUI.

First we need ModAPI itself:

If you haven't already, extract it somewhere.

Now we need Visual Studio (not Visual Studio Code!). You can grab it for free here:

You can even get Professional for free if you are a student. Optionally get the ReSharper extension.

Next, we need a DLL decompiler. There are some out there, but in this tutorial i will go with ILSpy:

or ILDASM
or Jetbrains dotPeek
or .NET Reflector
or dnSpy

In most games ModAPI specific methods, attributes, etc. can be used. However, Green Hell uses its own / unity methods. Continue at the Green Hell section for the tutorial and quirks.

Create Project

Open ModAPI, go to the development tab and click 'Create new project':

Give your project an ID. Click on the new mod on the left side. Give it a name and optionally a description:

If you need, add a hotkey in 'Assignable keys':

Open Project

Navigate to '/projects/TheForest/Day/' in your ModAPI folder and open the '*.sln' with Visual Studio.

Add a new class to our project:

Visual C# Items > Class > and name it something like 'Day.cs'. It should open and look something like this:

GUI

First, we need to add our stuff to the game. We do that by creating a new GameObject and appending our class:

[ExecuteOnGameStart] initializes it once the game starts.

Now we create the GUI layout with an input box, where you enter the day you want and a button to set the day:

We still need to open the menu by using the key we assigned in ModAPI:

Build Project

We can build and run our project and see if it works. Either click 'Start' or 'Build > Build Solution (CTRL + SHIFT + B)'

The build should finish with 'Build: 1 succeeded'.

Go to ModAPI and click 'Create Mod' in the lower right of your project. It should say 'Created mod successfully'. If you create the mod again in the future, increment the version or delete the mod in '<ModAPI>/mods/TheForest/Day*.mod'.

View the 'Mods'-Tab in ModAPI and toggle your new mod.

Click on 'Start game'.

Open a singleplayer game and hit our hotkey.

Now we need to find the function that actually changes the day.

Decompiling the game

Start ILSpy and click on 'File > Open'. Select the 'Assembly-CSharp.dll' in The Forest folder: '..SteamAppscommonThe ForestTheForest_DataManaged'

We can search for something like 'Day'. 'Clock.Day' luckily is public static, so we can call it directly.

Add to our button. This parses the value inside out textbox and sets the day.

Build the project again and we are done.

Injecting Code

To inject code into existing methods you have to extend from the class containing the method. As an example we look at the 'TheForestAtmosphere' class.

To add code into an existing method you just override the method. This is possible with public and private methods.

NOTICE: In the current ModAPI version you can only override methods with a void or bool return!

and

With this code you'll overwrite the whole method. To call the original code you have to add a call to the base method. When you do this, your method will be chained.

Notice that your code after the original method might not be executed when it returned before.

If you need to override functions which are also changed by other mods you can add this attribute to you function. Priority takes an integer which changes the execution order accordingly:

Adding methods, fields and classes

Besides the possibility of overwriting methods you can also add fields, methods annd classes. The overwriting of standard values of existing fields is not supported yet. An alternative for this purpose is to inject (or add) code into the Start() method. This method will be called by Unity when the MonoBehaviour object is created.

Debugging

To log some code or to test if something successfull or threw an exception you can write it to the log.

You can find the logfile in The Forest folder: '/Mods/Logs/*modname*.log'

GUI elements

Label

Button

Textfield

Toggle

There are other elements that you can use... just decompile other mods (*modname*.dll) like you did with The Forest and see how they implemented them.

Wrap up

Those were the basics in writing simple mods.

There is more to discover, e.g. loading Resources (images) into the game with ModAPI.

If you have problems or questions, feel free to ask them on our Discord server #development :)

Green Hell

This section is brought to you by Werkrat.

Project settings

Green Hell uses a different .NET Framework, so you need to change the target framework after creating the mod in ModAPI:

Click Project -> *project name* Properties
Set 'Target Framework' to '.NET Framework 4'
Click 'Yes'

You will have to change the target framework every time you use 'Build Mod' in ModAPI because it resets the framework version.

ModAPI attributes

Attributes aren't working in Green Hell, so [ExecuteOnGameStart] won't do anything. Depending on what you're doing, you might have to find a suitable insertion point:

Most of the time adding the GameObject after the player is initialized should be fine.