# Welcome to the GreenHell Modding docs!
GreenHellModding aims to extend the survival game Green Hell by adding mods. This site provides a clean overview over everything related to modding Green Hell.
# How to install GreenHellModLoader
This Tutorial aims to show you how to install GreenHellModLoader.
Let's get started with the first step!
### 1. Downloading the Launcher
First, download the latest version of our launcher [here](https://www.raftmodding.com/download). Then place it where ever you want, but we recommend you keep it on your desktop, or somewhere easy to use.
### 2. Terms of Service
Start the launcher by opening the file you downloaded. On first launch you will be prompted to accept our Terms of Service, which is necessary for using our software. By pressing "Agree", you confirm that you accept them. If you have any questions regarding you data privacy, please feel free to contact us via [Discord](https://www.greenhellmodding.com/discord) or via [E-Mail](https://www.greenhellmodding.com/contact).
### 3. Installation
After accepting the terms of service the launcher will download and install all the required files as shown below. You don't need to do anything here, just wait. It can be pretty fast as its less than 5 MB.
### 4. Launching modded Green Hell
And finally, once the launcher has downloaded and installed all required files, a **`Play`** button will appear as shown below. To start the mod loader, press the **`Play`** button and the game will start. Each time you want to play with mods you have to start the launcher and click on **`Play`**
### 5. Inside the game
Then once the game has loaded you should have a new menu in the Green Hell main menu as shown below. If the new menu does not show up in-game, take a look at our troubleshooting guide:
{% content-ref url="/pages/-M5Zpm9EWTlxTjzotG3z" %}
[Troubleshooting](/tutorials/how-to-install-greenhellmodloader/troubleshooting)
{% endcontent-ref %}
# Troubleshooting
When the software doesn't do what it should...
If installing the mod loader is not working as expected, don't worry. Please take a look at the following document which describes some of the more common issues with installing the mod loader. If none of this works, please join our [Discord server](https://raftmodding.com/discord) or contact us via [E-Mail](https://raftmodding.com/contact) and we will be happy to help you!
## What's wrong?
First of all, we need to find out what's the problem. Which of the following descriptions describes your problem best? If an error popped up, try to find the headline with the text describing the error.
* [The menu inside the game does not show up](https://api.raftmodding.com/tutorials/how-to-install-raftmodloader/troubleshooting#menu-not-showing-up)
* [Other / My problem could not be solved with this guide](https://api.raftmodding.com/tutorials/how-to-install-raftmodloader/troubleshooting#other)
## 'The menu inside the game does not show up'
This is a fairly common issue so don't worry. Please do the following steps:
#### 1. Open the launcher
Close Green Hell if it is still running and open the launcher application.
#### 2. Open the settings
Click on Settings:gear:icon to open the Launcher settings.
#### 3. Change the starting method
In the settings, there is an option for changing the starting method. You can choose betweeen `Steam`, `Executable` and `Force Start`. If you have never changed this before, the current value should be `Steam`. **Please select `Force Start`.**
#### **4. Start the game**
Now, close the Settings by clicking the gear :gear: again and press `Play` to start the game.
#### 5. Did it work?
If this worked, you should now see the modding menu inside the game. If you can not see the menu as shown below, please go back to step 3 and try to change the Starting Method to `Executable`.
{% hint style="info" %}
If you can't solve this problem with this guide, make sure to contact us and we'll be happy to help you.
{% endhint %}
## Other / My problem could not be solved with this guide
It seems like your problem is a bit uncommon. But don't worry, we'll be happy to provide personal support on our [Discord server](https://raftmodding.com/discord) or via [E-Mail](https://www.greenhellmodding.com/contact).
# How to install a mod
This Tutorial aims to show you how to install a mod on Green Hell using GreenHellModLoader!
Let's get started with the first step!
### 1. Installing the mod loader
If you haven't done it already, install GreenHellModloader. Please review our guide on that topic for in-detail explanations.
{% content-ref url="/pages/-M5ZkIGCCRIsnL9l0NPQ" %}
[How to install GreenHellModLoader](/tutorials/how-to-install-greenhellmodloader)
{% endcontent-ref %}
### 2. Finding mods
To search and find mods of your choice, we highly recommend using our [mods directory](https://greenhellmodding.com/mods). Scroll through the page and click on the mod you would like to check out. Alternatively, you can find a list of the most popular mods on our [home page](https://greenhellmodding.com).
### 3. Downloading mods
On a mod's page you can find all information about a mod. You'll now need to download the mod by clicking `Download this mod` as shown below.
### 4. Locating your mods folder
Open the GreenHellModLoader Launcher and click on the `Mods Folder` button as shown below. Your system should now open a window showing the mods folder.
### 5. Installing the mod
After clicking on the Mods Folder button it will open your mods folder, drag and drop the downloaded .ghmod mod file in it as shown below.
### 6. Loading the mod
We're already done with installing the mod! Let's see how to load it in the game. Start the game by using the launcher and clicking on the **play** button. When the game has loaded go to the **Mod Manager** tab and if the mod has **load** button click on it as shown below. You will have to click `Load Mod` every time you start Raft.
If the mod you downloaded doesn't have a **load** button but has a **blue button** as shown below its a **Permanent Mod**, That means that its loaded by default and you don't have to deal with it.
### 7. Done?
If everything has worked out, the mod status should be green and the text should say **RUNNING...** as shown below.
### **Troubleshooting**
Oh no, is anything not working as expected? Make sure to join our [Discord server](https://www.greenhellmodding.com/discord) and we will be happy to help you.
# Mods in multiplayer
Everything you need to know before playing modded Green Hell with your friends.
You've already found out how to [install mods](https://docs.greenhellmodding.com/tutorials/how-to-install-a-mod) and have maybe had fun playing with mods alone. But of course, playing games is better together and you might ask yourself how to play modded Green Hell together with your friends.
### First things first: General rule
In a modded game, make sure that **all players inside a multiplayer game have the mod loader and the same mods installed**.
Some mods might work for individual players but others might break the world or crash the game if they are not installed for all players!
### Which mods work in multiplayer?
To our knowledge, basically all mods should usually work in multiplayer. To be sure, you can review the mod's page in our [mods directory](https://www.greenhellmodding.com/mods).
### Further questions
If you have further questions, you can ask us anything on our [Discord server](https://www.greenhellmodding.com/discord).
# How to create a mod project
This Tutorial aims to show you how to create a mod project on Green Hell using GreenHellModLoader!
Let's get started with the requirements!\
\
To get started modding you will need the following softwares :
* [**Visual Studio Community**](https://visualstudio.microsoft.com/downloads/). We highly recommend you to download the 2019 version.
* [**Unity 2019.3.9f1**](https://unity3d.com/unity/whats-new/2018.3.5). If you have [UnityHub](https://public-cdn.cloud.unity3d.com/hub/prod/UnityHubSetup.exe) installed simply click [here](http://fastdl.greenhellmodding.com/downloadGreenHellUnityVersion.php).
* [**dnSpy**](https://github.com/0xd4d/dnSpy/releases/latest). This is the latest available version.
{% hint style="danger" %}
**You have to use Unity 2019.3.9f1! Using another version is not supported!**
{% endhint %}
Now that you have the required softwares, let's create your mod project!
**1)** Open the GHMLLLauncher and create a mod project by using the mod creator as shown below.
**2)** In the project name text field enter your mod name and hit **Create Project!** It will then tells you if it has succeeded and opens you the project folder as shown below.
**3)** Now that your mod project is created you can open the **.sln** file, in the case above i open **ExampleMod.sln** with Visual Studio.\
After opening it, open the **.cs** file as shown below.
**4)** Now that we created our mod project and opened it we can begin creating our mod!\
As you can see on the screenshot above, there is a lot of green lines, those are comments, read them to know what every line do. Now, let's create a shortcut of our project folder in our mods folder so we won't have to move files or build the mod each time we modify something in our mod. Yeah this is a great feature! 😁
{% hint style="info" %}
The folder is by default located in ***Documents\GreenHellModding\YourProjectName\YourProjectName***
{% endhint %}
{% hint style="warning" %}
Create a shortcut of this folder. \
**Its the folder that contains the`modinfo.json`file and the`.cs`file(s).**\
*The main folder should also work, but we highly recommend you to create a shortcut of the second one.*
{% endhint %}
**6)** Now, let's start the mod loader, Load our mod and open the console using F10 to see what's happening.
Just after loading the mod. The status change to green and says "Running...". Your mod is now running!
As you can see when you press F10 it executes the code in the Start() method.
**7)** Now that you know how to write code, to modify your mod information such as its description, its license, the icon, the banner etc simply go in to your mod project files and edit the **modinfo.json** file as shown below.
If you want to know more about this file, how to add an icon, what is the excludedFiles field etc, click below.
{% content-ref url="/pages/-M5e60xpeq7Cc7L9g6sM" %}
[The modinfo.json file](/modding-tutorials/how-to-create-a-mod-project/the-modinfo.json-file)
{% endcontent-ref %}
**8)** Now that you know how to write your mod and how to change its information to build it, simply generate the visual studio project and our build script will automatically pack/build your mod as shown below. The build script will generate a new file named `YourModName.ghmod` This file is the mod file to upload on our [site](https://www.greenhellmodding.com) and to put in the mods folder.
**And here is it! You made your first mod project!**\
**Keep in mind this tutorial is just the requirements & basics!**\
**More advanced tutorials are coming soon!**
# The modinfo.json file
This page aims to give you all the needed information about the modinfo.json file.
Here is a list of all the fields of the modinfo.json file and a small description/usage of them.\
More info about them below this table.
| Field Name | Description |
| ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **name** | Type : String
Description : The display name of your mod.
|
| **author** | Type : String
Description : Your username.
|
| **description** | Type : String
Description : A small description of your mod.
|
| **version** | Type : String
Description : The current version of your mod.
Usage : We recommend using Semantic Versioning 2.0.0
|
| **license** | Type : String
Description : The license of your mod.
Usage : You can find many licenses on choosealicense.com
|
| **icon** | Type : String / Path
Description : An icon for your mod. (Can be seen in the mod manager list)
Usage : We recommend you a 512x512 png or jpg image.
|
| **banner** | Type : String / Path
Description : A banner for your mod. (Can be seen in the mod manager list)
Usage : We recommend you a 660 x 200 png or jpg image.
|
| **gameVersion** | Type : String
Description : The version of Green Hell that you made was made for.
Usage : This is just for info, Mods should remain compatible across versions.
|
| **updateUrl** | Type : String / Url
Description : A link that returns the latest available version of your mod.
Usage : Our site provides you an url when you release your mod.
|
| **isModPermanent** | Type : Boolean (true or false)
Description : Defines if your mod is permanent. Permanent mods are loaded by default and can't be unloaded. This is needed when mods add new items/blocks that can't really be unloaded without causing issues.
|
| **excludedFiles** | Type : Array of strings / List of strings
Description : Allows you to specify files to not load. This doesn't support wildcards yet.
Usage : Useful when you want to exclude files like readme or source files.
|
\
**Icon & Banner Fields :** \
**Just add an image to your solution folder where your `.cs` files and the `.csproj` file is and edit the `modinfo.json` file as shown below.**
**UpdateUrl Field :**\
**GreenHellModLoader fetch this link to know what is the latest available version of your mod, if the currently installed version is not equal to the version returned by this url it will say that the mod is outdated.**\
**Our website offer this service with a nice automation system. Available on the following link once you have a mod slug.**\
`https://greenhellmodding.com/api/v1/mods/`**`YOURMODSLUG`**`/version.txt`
**ExcludedFiles Field :**\
**This is a simple list of excluded files as shown below.**
