# Welcome to the RaftModding docs!
**Welcome to RaftModding: Enhancing Your Raft Adventure!**
RaftModding is your go-to destination for expanding your Raft gameplay.
We are the largest community dedicated to mods, scripts, and utilities for Raft, the popular survival game.
Our platform serves as a central hub, offering a comprehensive overview of all things related to modding Raft.
{% hint style="info" %}
Interested in contributing to our documentation?\
Click [here](https://github.com/tekgamer950/raftmoddingdocs) to begin. :relaxed:
{% endhint %}
# Installing Raft Mod Loader
This tutorial is designed to guide you through the process of installing RaftModLoader.
## 1. Downloading the Launcher
**Start by downloading our latest launcher version from** [**here**](https://www.raftmodding.com/loader)**.**\
After downloading, you can place it anywhere you prefer.\
We suggest keeping it on your desktop or another easily accessible location for convenience.
Press the green button to download the latest launcher version from our website.
## 2. Terms of Service
**Open the downloaded file (*****RMLLauncher.exe*****) to launch the program**.\
When you start it for the first time, you'll see our Terms of Service.\
**You must agree to them to use our software.**\
Click 'Agree' to confirm your acceptance.
If you have privacy concerns or questions, don't hesitate to reach out to us on [Discord](https://www.raftmodding.com/discord).
## 3. Installation
After accepting the Terms of Service, the launcher will automatically download and install all the necessary files, as displayed below. **You don't need to take any action; simply wait**.\
The process is usually quick.
## 4. Launching modded Raft
After the launcher has downloaded and installed all the necessary files, a "**Play**" button will appear, as depicted below.\
**Press this button to start the game using the mod loader**.
{% hint style="info" %}
Remember, whenever you want to play with mods, initiate the launcher and press the button to launch the game with the mod loader.
{% endhint %}
## 5. Inside the game
After the game has loaded, you will find a **new menu in the Raft main menu**, as illustrated below. If the new menu does not appear in-game, please refer to our troubleshooting guide here.
## **6. Installing your first mod**
{% hint style="success" %}
Congratulations! If you've reached this point, **you've successfully installed RaftModLoader**!\
\
Now, **you are ready to install some actual mods**.
{% endhint %}
If something isn't working as expected, maybe take a look at our troubleshooting guide:
{% content-ref url="/pages/Kq1ItXHENo1Tu47hkztV" %}
[Troubleshooting](/getting-started/installing-raft-mod-loader/troubleshooting)
{% endcontent-ref %}
# Troubleshooting
Helping you to troubleshoot common issues with the Raft Mod Loader
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](https://raftmodding.com/discord) 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
%20\(1\).webp?alt=media)\
This is what it should look like...\
\
[Link to the guide](/getting-started/installing-raft-mod-loader/troubleshooting/the-menu-inside-the-game-doesnt-show-up)
"An error occured while fetching for updates"
.png?alt=media) .png?alt=media)
[Link to the guide](/getting-started/installing-raft-mod-loader/troubleshooting/an-error-occured-while-fetchting-for-updates)
The game crashes on startup
%20\(2\).png?alt=media)
[Link to the guide](/getting-started/installing-raft-mod-loader/troubleshooting/the-game-crashes-on-startup)
There's an error counter going up very fast in the bottom right hand corner of the game
.webp?alt=media)
[Link to the guide](/getting-started/installing-raft-mod-loader/troubleshooting/there-are-error-notifications-in-game)
## 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 support on our [Discord server](https://raftmodding.com/discord). :blush:
# An error occured while fetching for updates
This guide aims to fix the following error : "An error occured while fetching for updates"
There are multiple reasons this issue can be happening. The first and most likely one is your antivirus interfering. Follow the linked guide and see if it helps:
{% content-ref url="/pages/z7vV6Jp2jDryi3VQ7vP5" %}
[Configuring your antivirus](/getting-started/installing-raft-mod-loader/configuring-your-antivirus)
{% endcontent-ref %}
If that doesn't help, don't worry we got you :wink:
{% content-ref url="/pages/RqXnoP4qhd3TQJai8vzK" %}
[Disabling IPV6](/getting-started/installing-raft-mod-loader/troubleshooting/an-error-occured-while-fetchting-for-updates/disabling-ipv6)
{% endcontent-ref %}
If that didn't help too try changing the DNS
{% content-ref url="/pages/J4H68e9rY5MKvMls9TKD" %}
[Changing the DNS](/getting-started/installing-raft-mod-loader/troubleshooting/an-error-occured-while-fetchting-for-updates/changing-the-dns)
{% endcontent-ref %}
## 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 support on our [Discord server](https://raftmodding.com/discord). :blush:
# Disabling IPV6
This guide will explain how to disable IPV6
This issue might be caused by IPV6 being enabled on your computer. A Windows bug can cause the requests to fail when going through ipv6 and it can be safely disabled.\
\
1\. Open the **Control Panel** (through the Cortana search box for example).\
2\. Open **Network and Internet**.
3\. Open **Network and Sharing Center**.
4\. Click **Change Adapter Settings**.
5\. Right-click your connection and go to **Properties**.
6\. Uncheck the box next to **Internet Protocol Version 6 (TCP/IPv6) to disable it.**
7\. Select **OK to confirm** the change.
8\. **Restart the computer** and try again running the launcher.
# Changing the DNS
This guide will explain how to change your DNS to the Google one which is not blacklisting our website
1\. Let's check if that's the issue first. **Open your command prompt** by **typing CMD** in the Cortana search bar for example and **select "Run as administrator"**:
2\. **Run the following commands**: `nslookup raftmodding.com` and `nslookup raftmodding.com 8.8.8.8`
If the ip adresses are different that means that there's an issue with the DNS and it might be blocking the Raftmodding requests.\
\
3\. We will **change the DNS** to one that is not blacklisting our website like the Google DNS. Here's a guide on how to setup the Google DNS on your system: \
\
4\. Once you're done setting up the DNS make sure to **restart the computer** and try again running the Mod Launcher. You might also need to **change the DNS on your router**. The steps will be very dependent on your router.
# The menu inside the game doesn't show up
This guide aims to fix an issue where the mod menu doesn't appear in-game
## 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 Raft if it is still running and open the launcher application as **administrator**.
#### 2. Open the settings
Click on Settings:gear:icon to open the Launcher settings.
#### 3. Change the starting method
In the settings, you need to enable **`Start Game From Steam`**:
#### **4. Start the game**
Now, close the Settings 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, try excluding the mod loader from your antivirus:
{% content-ref url="/pages/z7vV6Jp2jDryi3VQ7vP5" %}
[Configuring your antivirus](/getting-started/installing-raft-mod-loader/configuring-your-antivirus)
{% endcontent-ref %}
The mod menu inside of the game
# The game crashes on startup
Fixing the issue of the game crashing on startup
Same steps as for [The menu inside the game doesn't show up.](/getting-started/installing-raft-mod-loader/troubleshooting/the-menu-inside-the-game-doesnt-show-up)
# There are error notifications in-game
Fixing the issue of the error counter going up in the bottom right hand corner
In the following, we will **verify the files' integrity**. This is a Steam tool that allows checks and repairs broken game files.
1. Open Steam and open the *Library* tab.
2. Right-click *Raft* and select *Properties* in the pop-up-menu.
3. In the menu, select the *Local files* tab.
4. Click on the *Verify integrity of game files* button.
5. If the tool finds any broken files, it will automatically repair them.
6. Once done, you can close the windows.
7. Now, try to open the Launcher again.
8. Does it work now? If the error keeps coming up, this might be related to your Antivirus program.
*For visual guidance, check out the* [*Steam Support article*](https://support.steampowered.com/kb_article.php?ref=2037-QEUH-3335) *about this topic.*
{% hint style="info" %}
If you can't solve this problem with this guide, make sure to [contact us](#other) and we'll be happy to help you.
{% endhint %}
# Linux or Steam Deck installation
This Tutorial aims to show you how to install RaftModLoader on Linux and Steam Deck.
Setting up Raft Mod Loader is now easier than ever due to the proton compatibility layer built into Steam. This guide aims to show you how you can achieve this on your own Linux-based machine.
First, a starting note for the Steam Deck users:\
To access the Linux Desktop on the Steam Deck do the following:
Another general note:\
The install button on the Raftmodding website unfortunately does not work, so you will have to add the mods to the mod folder manually.
Now let's get started π
### 1. Setting up our game directory
First download the shim file from and download the Raft Mod Launcher from .
Next place both of the downloaded files into your Raft game folder usually located at /home/$USER/.steam/steam/steamapps/common/Raft.
{% hint style="info" %}
The .steam folder will be hidden if you have 'Show Hidden Files' disabled in your file manager so you will need to enable the setting.
{% endhint %}
The Raft folder should now look like this:
Before moving to the next step, make sure the shim file is executable. The shim file can be set as executable by opening the file properties in your file manager or running the following command inside of your terminal.
```bash
chmod +x shim
```
### 2. Setting up the launch parameters inside of Steam
First open Steam. Next go into your Steam Library, go to Raft, right-click onto the game and click on properties.
On the general tab you'll find an input field called launch options. Add the following into that field:
```bash
./shim %command%
```
### 3. Preparing the target file
Now startup Raft on Steam. The game should start up as usual. Close it once it is done starting.
Go back into your Raft game directory. There should now be a new file called 'target'. Open the file and replace Raft.exe with RMLLauncher.exe as seen below
```
/path/to/game/RMLLauncher.exe
```
### 4. Launching the game with mods
Startup Raft on Steam. You should now see the mod launcher coming up. Go through the setup process until you reach the following window.
Press play and the game should start with mods! You should see this mod menu once the game reaches the main menu:
{% hint style="info" %}
If you encounter any issues or the guide doesn't seem to work for you, please visit the #support-tickets channel on our [Discord](https://www.raftmodding.com/discord).\
\
Our team is more than happy to assist you. π
{% endhint %}
#### Credits
This guide was made with the help of @xenozma. Feel free to ask them for assistance on the Raftmodding Discord regarding this guide.
# Configuring your antivirus
This page will guide you on resolving false positive errors on RMLLauncher, ensuring a smoother experience without unnecessary interruptions.
## **Why is my antivirus suspecting RMLLauncher to be a Trojan/Malware?**
{% hint style="success" %}
**RMLLauncher is completely safe to use.**\
\&#xNAN;*It's important to note that both RMLLauncher and Core are open-sourced, allowing users to analyze the code.*
{% endhint %}
Our launcher behavior might seem unusual to antivirus programs because it involves downloading files, loading code into the game and connects to servers.\
We also do not possess a yearly Microsoft code signing license, which can trigger alerts.
Since our software is open-sourced, If it were a virus, someone would have noticed by now.\
Rest assured, our community has thoroughly examined the software. So, you can trust RMLLauncher without any concerns. π
## 1. Adding exclusions in your antivirus
To prevent false positives for the launcher, add these two exclusions to your antivirus settings:
1. **RMLLauncher.exe**
2. **C:\Users\YourUserName\AppData\Roaming\RaftModLoader**
Select your Antivirus from the list below to get a detailed guide:
{% content-ref url="/pages/tenqQRFcnobDUeCbaGfw" %}
[Windows Defender](/getting-started/installing-raft-mod-loader/configuring-your-antivirus/windows-defender)
{% endcontent-ref %}
{% content-ref url="/pages/kwSOe9bB3qoX9fHnYEit" %}
[Malwarebytes](/getting-started/installing-raft-mod-loader/configuring-your-antivirus/malwarebytes)
{% endcontent-ref %}
{% content-ref url="/pages/OE99UJVl3ZzmDwxfLcmH" %}
[Avast](/getting-started/installing-raft-mod-loader/configuring-your-antivirus/avast)
{% endcontent-ref %}
{% content-ref url="/pages/hlhJfxIoLxP1EAajVK3s" %}
[Norton](/getting-started/installing-raft-mod-loader/configuring-your-antivirus/norton)
{% endcontent-ref %}
{% content-ref url="/pages/FjiriMaXIFpQxN8B75Ls" %}
[Bitdefender](/getting-started/installing-raft-mod-loader/configuring-your-antivirus/bitdefender)
{% endcontent-ref %}
{% content-ref url="/pages/xiN3a6hJSkgkWPyMVQxa" %}
[AVG](/getting-started/installing-raft-mod-loader/configuring-your-antivirus/avg)
{% endcontent-ref %}
Your antivirus is not on the list? Search on google **"how to add exclusions in \[Your antivirus name...]"** and there should be a support website from that antivirus explaining how to do it. You will have to add both exceptions [mentioned above ](#1.-adding-exclusions-in-your-antivirus):point\_up:
## 2. You should be done !
**Simply restart our launcher and it should be working !**
{% hint style="info" %}
If you encounter any further errors or experience the same issue, please visit the #support channel on our [Discord](https://www.raftmodding.com/discord).\
\
Our team is more than happy to assist you. π
{% endhint %}
# Windows Defender
Explaining how to exclude the Raft Mod Loader from the Windows Defender antivirus
Go into "Windows Security" -> "Virus & threat protection". Then click on "Manage settings" under "Virus & threat protection settings":
Scroll down to Exclusions and click on "Add or remove exclusions":
Click on "Add an exclusion" -> "File" then select the **RMLLauncher.exe**.
Do that again but instead of selecting "File" you now want to select "Folder" and exclude the **RaftModLoader** folder which is located at **C:\Users\YourUserName\AppData\Roaming\RaftModLoader** .
This is how the exclusions should look like in the end:
Finally restart the computer to apply the settings!
## Aaaand you're done !
**Simply restart our launcher and it should be working !** :thumbsup:
# Malwarebytes
Explaining how to exclude the Raft Mod Loader from the Malwarebytes antivirus
Open Malwarebytes and go into the settings and select the "Allow List" tab. Click on add, then select allow file or folder.
Select the **RMLLauncher.exe** as the file you want to exclude:
Then hit "Done" and do the same for the **RaftModLoader** folder which is located at **C:\Users\YourUserName\AppData\Roaming\RaftModLoader** .
Next let's add the exceptions for the Website:
Click on "Add" -> "Allow a website" and exclude `fastdl.raftmodding.com`
Then hit done and do the same for `raftmodding.com`
Your exception list should look something like this :
Finally restart the computer to apply the settings!
## Aaaand you're done !
**Simply restart our launcher and it should be working !** :thumbsup:
# Bitdefender
Explaining how to exclude the Raft Mod Loader from the Bitdefender antivirus
Open Bitdefender, go into the "Protection" tab and open the "Antivirus". Switch to the "Settings" tab and select "Manage Exceptions":
Click on "Add an Exception":
Create an exception for the RMLLauncher.exe making sure every protection feature will be disabled:
Then hit "Save" and do the same for the RaftModLoader folder which is located at **C:\Users\YourUserName\AppData\Roaming\RaftModLoader** as well as the **HMLCore.exe** file located in **C:\Users\YourUserName\AppData\Roaming\RaftModLoader .**
These are the exceptions you should have now:
Also make sure to check the quarantine for any files related to the mod loader and to restore them!
Finally restart the computer to apply the settings!
## Aaaand you're done !
**Simply restart our launcher and it should be working !** :thumbsup:
# Avast
Explaining how to exclude the Raft Mod Loader from the Avast antivirus
Open Avast then click on "Menu" in the top right and select "Settings":
Go into the "General" then "Exceptions" tab:
Now click on "Add Exception"-> "Browse". It is a bit tedious to select exceptions as you need to check the box next to the File/Folder. First you select the **RMLLauncher.exe :**
And then you select the **RaftModLoader** folder which is located at **C:\Users\YourUserName\AppData\Roaming\RaftModLoader**:
Once both are selected hit "Ok". Then "Add Exception":
Now click on "Add Exception" again:
And let's add exceptions for the website:
`raftmodding.com`
and `fastdl.raftmodding.com` .
This is how the exceptions should look like for you in the end:
Now go into the "Blocked & Allowed Apps tab" and click on "Allow App":
Then "Select App Manually":
Do this for the RMLLauncher.exe
as well as the **HMLCore.exe** file located in **C:\Users\YourUserName\AppData\Roaming\RaftModLoader .**
This is what the exceptions should look like:
Finally restart the computer to apply the settings!
## Aaaand you're done !
**Simply restart our launcher and it should be working !** :thumbsup:
# Norton
Explaining how to exclude the Raft Mod Loader from the Norton antivirus
First let's add the exception to the Norton Antivirus:
Open Norton then go to "Settings"-> "Scans and Risks" and scroll down to "Exclusions/Low risks":
At "Items to Exclude from Scans", click on "Configure"->"Add Files":
Add an exception for the **RMLLauncher.exe** you downloaded:
As well as for the **HMLCore.exe** located in **C:\Users\YourUserName\AppData\Roaming\RaftModLoader .**
Then click on "Add Folders" to add an exception for the entire **RaftModLoader** folder located at **C:\Users\YourUserName\AppData\Roaming\RaftModLoader .**
This is what your exceptions should look like. Confirm by hitting "Apply" then "Ok":
Now add the exact same exceptions for "Items to Exclude from Auto-Protect, Script Control, Behavioral Protection and Download Intelligence Detection":
After you're done hit "Apply" and then "Ok":
If the Raft Mod Loader can't connect to the internet, you'll need to add an exception to your firewall too:
1. Go to **Settings** -> **Firewall** -> **Application Control**
2. Use the search function to find **`HML`**
3. Allow network access for **`HML`**
Finally restart the computer to apply the settings!
## Aaaand you're done !
**Simply restart our launcher and it should be working !** :thumbsup:
# AVG
Explaining how to exclude the Raft Mod Loader from the AVG antivirus
Open AVG then click on "Menu" in the top right and select "Settings":
Go into the "General" then "Exceptions" tab:
Now click on "Add Exception"-> "Browse". It is a bit tedious to select exceptions as you need to check the Box next to the File/Folder. First you select the **RMLLauncher.exe :**
And then you select the **RaftModLoader** folder which is located at **C:\Users\YourUserName\AppData\Roaming\RaftModLoader**:
Once both are selected hit "Ok". Then "Add Exception":
Now click on "Add Exception" again:
And let's add exceptions for the website:
`raftmodding.com`
and `fastdl.raftmodding.com` .
This is how the exceptions should look like for you in the end:
Now go into the "Blocked & Allowed Apps tab" and click on "Allow App":
Then "Select App Manually":
Do this for the RMLLauncher.exe
as well as the **HMLCore.exe** file located in **C:\Users\YourUserName\AppData\Roaming\RaftModLoader .**
This is what the exceptions should look like:
Finally restart the computer to apply the settings!
## Aaaand you're done !
**Simply restart our launcher and it should be working !** :thumbsup:
# Installing a mod
This tutorial is here to guide you through the process of installing a mod on Raft using RaftModLoader!
## 1. Installing the mod loader
If you haven't done so already, please install RaftModLoader. \
For detailed explanations, refer to our guide on this topic.
{% content-ref url="/pages/Z8OY6gQt59Is2eDWLj0Q" %}
[Installing Raft Mod Loader](/getting-started/installing-raft-mod-loader)
{% endcontent-ref %}
## 2. Finding mods
To search and discover mods of your choice, we strongly recommend utilizing [our mods directory](https://www.raftmodding.com/mods). Simply scroll through the page and click on the mod you're interested in.\
Alternatively, you can find a list of the most popular mods on [our home page](https://www.raftmodding.com/).
## 3. Installing a mod
On a mod's page, you can find all the information about the mod.\
**To install it, just click the large green '*****Install Mod*****' button.**
Your browser may prompt you to allow raftmodding.com to open the Raft Mod Loader for installing a mod. **Click '*****Open*****' to proceed.**
{% hint style="info" %}
If nothing happens, you can download the mod's .rmod file by clicking '***Download this mod***' and place it in the '***mods***' folder inside your Raft directory.
{% endhint %}
## 4. Allowing the mod installation
Now, the Raft Mod Installer should open.\
It will display the mod that is about to be installed and ask you once again if you want to proceed. **Click '*****Yes, Install It*****' to begin the installation.**
## 5. Loading the mod
We've installed the mod! To load it, start the game using the launcher's 'Play' button.\
In the game, go to 'Mod Manager' tab. **Click '*****Load Mod*****' if available**; for Permanent Mods, no action is needed.
## 6. You are done !
If everything worked out, the mod status will be green, and the text should say '***RUNNING...***' as shown below.
{% hint style="success" %}
There you have it! Your first mod is now successfully installed and active!
{% endhint %}
## **Troubleshooting**
Encountering issues? Don't worry! If anything isn't working as expected, join our [Discord server](https://www.raftmodding.com/discord), and we'll be more than happy to assist you.
# Mods in multiplayer
This page explains multiplayer mod usage.
You've learned [how to install mods](/getting-started/installing-a-mod) and perhaps enjoyed playing solo.\
Wondering how to play modded Raft together? Here's the key:
## **General Rule**
In a modded game, ensure all players in multiplayer have the mod loader and the same mods installed.\
Some mods may function individually, but others might disrupt the world or crash the game if not installed universally.
## **Compatibility in Multiplayer**
As far as we know, most mods should work in multiplayer.\
For confirmation, check the mod's page in [our mods directory](https://www.raftmodding.com/mods).
## **Have More Questions?**
If you need further assistance, feel free to ask us anything on our [Discord](https://www.raftmodding.com/discord).
# How to run multiple raft instances
A quick guide to run multiple Raft instances on a single computer with different Steam accounts, ideal for testing multiplayer mods.
I'll guide you through running multiple Raft instances simultaneously. To begin, you'll need:
1. [**Sandboxie-Plus:**](https://sandboxie-plus.com/) Allows isolated program execution.
2. [**A Second Raft Copy**](https://store.steampowered.com/app/648800/Raft/)**:** You need 2 Raft accounts for running two instances.
Let's get started!
## **1. Installing Sandboxie-Plus**
* Download and install Sandboxie-Plus from [here](https://sandboxie-plus.com/).
* Creata a new sandbox, name it as you like and add an access to your drive as shown below.
{% hint style="info" %}
We recommend granting access to the entire drive in the isolated environment because it includes crucial folders like AppData, world directories, Raft Settings, and Mod Loader files.
{% endhint %}
## **2. Duplicating Steam Software**
* Create a new folder for the second Steam.
* Copy your steam folder in this folder (You may want to remove other games than raft in the destination folder).
## **3. Installing Steam in Isolated Environment**
* Run steam.exe in the second Steam folder using Sandboxie-Plus.
* Start Steam in the isolated environment and select "Run As UAC Administrator".
## **4. Starting Raft**
* Log in with your second Steam account.
* Start Raft with "-rml" or through RMLLauncher opened inside sandboxie too; it should work seamlessly!
# How to create a mod project
This tutorial is here to guide you through creating a mod project on Raft using RaftModLoader!
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.5f1**](https://unity3d.com/fr/unity/whats-new/2019.3.5). If you have [UnityHub](https://public-cdn.cloud.unity3d.com/hub/prod/UnityHubSetup.exe) installed simply click [here](http://fastdl.raftmodding.com/downloadRaftUnityVersion.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.5f1! Using another version is not supported!**
{% endhint %}
Now that you have the required softwares, let's create your mod project!β
**1)** Open the RMLLLauncher 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! π
The folder is by default located in ***Documents\RaftModding\YourProjectName\YourProjectName***
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.\_β
**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.[The modinfo.json file/modding-tutorials/how-to-create-a-mod-project/the-modinfo.json-fileβ](https://github.com/TeKGameR950/RaftModdingDocs/blob/master/modding-tutorials/how-to-create-a-mod-project/broken-reference/README.md)
**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.rmod` This file is the mod file to upload on our [site](https://www.greenhellmodding.com/) and to put in the mods folder.β
**And here it is! 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.
|
| **requiredByAllPlayers** |
Type : Bool
Description : Is the mod required by all players to work?
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 :** \
**RaftModLoader 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://www.raftmodding.com/api/v1/mods/`**`YOURMODSLUG`**`/version.txt`
**requiredByAllPlayers Field :**\
**If this field is set to true and the mod is loaded it will kick any player attempting to join that does not have the same mod and the same version. If your mod adds new items or new blocks, this definitely needs to be true! So nobody will be able to join with missing blocks!**
**ExcludedFiles Field :** \
**This is a simple list of excluded files as shown below.**
# How to create an AssetBundle
This tutorial is designed to demonstrate how to import assets into the game, including 3D models, textures, prefabs, particles, and more.
Let's get started with the requirements!\
For this tutorial you will need the same requirements as the first tutorial.
**1)** First, create a new Unity project with the same version as the one required in [**How to create a mod project**](https://api.raftmodding.com/modding-tutorials/how-to-create-a-mod-project).
**2)** Then once the first step is done, download [this file](https://fastdl.raftmodding.com/AssetBundleBuilder.zip) and place it into your Unity Project as shown below. This will allow you to build your asset bundle file.
**3)** Add your stuff to the asset bundle as shown below.
**4)** Once you have everything in your assetbundle, build it by right clicking anywhere and clicking on **Build AssetBundles** as shown below.
**5)** If your assetbundle has succeeded building you should be able to find it in **Assets/AssetBundles**; Once you found it, copy it into your mod project folder where your .cs files and your modinfo.json file are located as shown below.
**6)** Now let's load it into the game using our previous mod made in the [**How to create a mod project** ](https://github.com/TeKGameR950/RaftModdingDocs/blob/master/modding-tutorials/broken-reference/README.md)tutorial. Open your mod project and change your start method type from **`void`** to **`IEnumerator`** and copy the code below into the start method as shown below; You will also need to create a new variable in your mod to be able to access the asset bundle from anywhere in your mod.
{% tabs %}
{% tab title="Help Image" %}
{% hint style="info" %}
If\*\*`IEnumerator`\*\* is underlined in red, simply add \*\*`using System.Collections;`\*\*at the top of your mod file.
{% endhint %}
{% endtab %}
{% tab title="Code" %}
```csharp
AssetBundle asset;
public IEnumerator Start()
{
AssetBundleCreateRequest request = AssetBundle.LoadFromMemoryAsync(GetEmbeddedFileBytes("tutorial.assets"));
yield return request;
asset = request.assetBundle;
}
```
{% endtab %}
{% endtabs %}
**7)** Loading an asset bundle is good, but we also need to unload it when we unload our mod. So, to do that in your ***`OnModUnload`*** method simply add **`asset.Unload(true);`** as shown below.
**8)** Now, to load something from our asset bundle simply use **`asset.LoadAsset("assetname")`** for example to load the ***RedCube*** that i added into the example asset bundle earlier i can just do **`asset.LoadAsset("RedCube")`** as shown below.
# Installing Raft Mod Loader
This tutorial is designed to guide you through the process of installing RaftModLoader.
## 1. Downloading the Launcher
**Start by downloading our latest launcher version from** [**here**](https://www.raftmodding.com/loader)**.**\
After downloading, you can place it anywhere you prefer.\
We suggest keeping it on your desktop or another easily accessible location for convenience.
.png?alt=media)
.png?alt=media)
.png?alt=media)
.png?alt=media)
.png?alt=media)
.png?alt=media)
.png?alt=media)
.png?alt=media)
.png?alt=media)
%20(1).png?alt=media)
%20(1).png?alt=media)
%20(1).png?alt=media)
%20(1)%20(1).png?alt=media)
%20(1)%20(1).png?alt=media)
%20(1)%20(1).png?alt=media)
%20(1).png?alt=media)
%20(1).png?alt=media)
%20(1).png?alt=media)
%20(1).png?alt=media)
%20(1).png?alt=media)
.png?alt=media)
.png?alt=media)
.png?alt=media)
.png?alt=media)
.png?alt=media)
.png?alt=media)
.png?alt=media)
.png?alt=media)
.png?alt=media)
.png?alt=media)
.png?alt=media)
.png?alt=media)
.png?alt=media)
%20(1).png?alt=media)
%20(1).png?alt=media)
%20(1).png?alt=media)
.png?alt=media)
.png?alt=media)
And here is it! As this can be a bit complicated if you encounter any issue or if you are blocked at a specific step, feel free to join our [Modding Discord](https://www.raftmodding.com/discord) and ask for help in [#support](https://discordapp.com/channels/451507895075471383/636994378618896436).
# How to create console commands
This tutorial is intended to guide you through creating custom console commands using the new console attributes.
Console commands are method attributes, that means that you just have to add `[ConsoleCommand(name: "...", docs:"...")]` or `[ConsoleCommand("...","...")]` above your method.\
The **name** argument is the command name itself.\
The **docs** argument is the command description.
{% hint style="info" %}
**Your method does not need to be public but it needs to be static!**
{% endhint %}
If you want to get the arguments of your command when its ran you can simply add a string\[] parameter named `args` as shown below.
```csharp
[ConsoleCommand(name: "useful", docs: "this command is useful.")]
public static void MyCommand(string[] args)
{
Debug.Log("You entered " + args.Length + " arguments!");
}
```
The method can also have a string return type and will display the returned value as shown below.
```csharp
[ConsoleCommand(name: "useful", docs: "this command is useful.")]
public static string MyCommand(string[] args)
{
return "You entered " + args.Length + " arguments!";
}
```
As said above, commands needs to be static, so in order to access your non static variables you can use the mod instance as shown below.
```csharp
public string myNonStaticVariable = "some stuff";
public MyModType instance;
void Start(){
instance = this;
}
[ConsoleCommand(name: "useful", docs: "this command is useful.")]
public static string MyCommand(string[] args)
{
return "My Variable : " + instance.myNonStaticVariable;
}
```
{% hint style="info" %}
The commands are automatically registered and automatically unregistered when the mod is unloaded.
{% endhint %}
# Harmony basics
This tutorial is intended to guide you through using Harmony to patch the game methods and more.
```csharp
using HarmonyLib;
```
## Adding to Code
To make your code work with existing mechaincs many times you will need to add your own code to a built in object. This can also let your mod act differently depending on if the player has specific other mods installed as well such as modifying recipes to use mod items if available or use vanilla items otherwise.
Harmony lets you do this by creating Patches. There are a few valid ways to set up your patches but a reliable one is to use attributes.
Each Patch will be its own class like so:
```csharp
[HarmonyPatch(typeof(BlockCreator), "CanBuildBlock")]
public class HarmonyPatch_IgnoreCollisionOnAlt
{
[HarmonyPrepare]
static bool IsCoolModInstalled()
{...}
[HarmonyPostfix]
static BuildError CheckForAlt(BuildError __result)
{...}
}
```
With one or more static methods that add or act on the target code.
{% hint style="warning" %}
Remember, your methods need to be static!
{% endhint %}
The class attribute lets Harmony know "what" to use the code on. typeof(BlockCreator) means it is trying to change how one of the methods of the BlockCreator works. That method is CanBuildBlock() and Harmony searches for it by string so make sure it matches the method name!
The method attribute lets Harmony know "when" to use the code in the patch. There are \[HarmonyPrepare], \[HarmonyPrefix], \[HarmonyPostfix], \[HarmonyTranspiler], and \[HarmonyTargetMethod] each executing at a different time or in a different way.
### \[HarmonyPrepare]
This lets you check some things before the patch takes place to see if you even want to change something.
This method expects you to return `false` to indicate Harmony should skip this patch.
```csharp
[HarmonyPrepare]
static bool IsBoxOpeningChanged()
{
//Look at all methods that got patched.
foreach(MethodBase method in Harmony.GetAllPatchedMethods()){
//See if the one you need has been modified
if(method.Name == "OpenBox")
//Skip patch because another mod changed something you use
return false;
}
return true;
}
```
### \[HarmonyPrefix]
This code takes place just before the original method happens and can be used to skip it all together.
This means you can replace a method entirely by having a Prefix do stuff then skip the original method by returning `false`
If the original method needed to return some value the patched method can accept the `ref "Type" __result` arguement by reference. This will make it look like the original method is returning whatever `__result` is set to
```csharp
[HarmonyPrefix]
static bool AlwaysReturnTrue(ref bool __result)
{
//Set return value to true
__result = true;
//Tell Harmony to not run the original method
return false;
}
```
You can also use this method to store values that can be accessed in the Postfix if you have one via `__state`. You can use `ref` or `out` to set the `__state` to whatever value or type you want. If you need to store more data then you need to make your own object to pass on to the Postfix
```csharp
static void Prefix(out Stopwatch __state)
{
__state = new Stopwatch(); // Stopwatch is a custom timer class
__state.Start();
}
static void Postfix(Stopwatch __state)
{
__state.Stop();
FileLog.Log(__state.Elapsed.ToString());
}
```
### \[HarmonyPostfix]
This code takes place right after the original method. It can take in the `__result` from the original method and use it or even change it.
One benefit of Postfixs is that they always run. No matter where the original method escaped its code from it will go to the Postfix right after.
{% hint style="info" %}
One quirk of Postfixs is that they can either change `__result` by ref or can return a value that would work the same way, but if they return a result it has to be the same Type as whatever the first arguement in the method is!
{% endhint %}
```csharp
[HarmonyPostfix]
static BuildError CheckForAlt(BuildError __result, BlockCreator __instance)
{...}
```
### \[HarmonyTranspiler]
Transpilers are a much more advanced way to get your own code to run. It is a bit out of the scope of a tutorial here so I will link to [this article](https://harmony.pardeike.net/articles/patching-transpiler.html#basic-transpiler-tutorial)
To give a simplified overview: Instead of writing code to be executed, you are looking at all of the IL instructions that a chunk of code represents and doing some of your own instructions whenever you think the right time is.
There are also wonderful tools out there that help show you what your IL code will look like from C# code snippets. Try checking out [LINQPad](https://www.linqpad.net/)
### \[HarmonyTargetMethod]
TargetMethod is another powerful tool that lets you reuse your code and apply changes to multiple different methods. It can also be used to conditionally apply changes based on what the code finds.
TargetMethod must return a MethodBase type which points at which method your patch will apply to. Alternatively \[HarmonyTargetMethods] can be used to apply the same patch logic to multiple methods as well though in this case it expects some IEnumerable collection of MethodBases.
Two different ways of doing this would be to iterate through, patching all methods:
```csharp
[HarmonyTargetMethods]
static IEnumerable