TUTORIALS
MODDING TUTORIALS
Client - API
Client - Code Examples
Website
Server - API
Server - Code examples
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?
version
Type : String
Description : The current version of your mod.
license
Type : String
Description : The license of your mod.
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 :
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.txtrequiredByAllPlayers 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.
Copy link