Packaging Mods - Modding-Haven/REEngine-Modding-Documentation GitHub Wiki

Overview:

This guide will walk you through the process of packaging a file replacement mod and a Lua script mod for REFramework (REF) with the intent of using Fluffy Mod Manager as the install method.

Packaging a File Replacement Mod:

Folder Structure:

MyModName/
├── modinfo.ini
├── thumbnail.png
└── natives/
    └── [Original File Path]
        └── ModifiedFile.extension

1. MyModName: The root folder for your mod.
2. modinfo.ini: Contains the metadata for your mod.
3. thumbnail.png: An image representing your mod.
4. natives: This path mimics the original structure of the game's files. You need to match the exact path of the file you are replacing.

Modinfo.ini Example:

[Mod Info]
name = My Texture Replacement
version = 1.0
author = Username
description = Replaces the default texture with a custom one.
screenshot = thumbnail.png

[Options]
category = Textures
addonfor = [Main Mod Name]
requirement = [Required Mod Name]

Zipping the Mod:

Once the folder structure is in place, zip the MyModName folder. The zipped file should contain the modinfo.ini, thumbnail.png, and the natives folder with your modified files.

Packaging a Lua Script Mod:

Folder Structure:

MyModName/
├── modinfo.ini
├── thumbnail.png
└── reframework/
    └── autorun/
        └── MyScript.lua
    └── data/
        └── MyScriptSettings/
            └── MyScriptSettings.json

1. MyModName: The root folder for your mod.
2. modinfo.ini: Contains the metadata for your mod.
3. thumbnail.png: An image representing your mod.
4. reframework/autorun: Inside this folder, place your Lua script(s). The script will be automatically run by REF when the game launches.
5. reframework/data: Place your json file(s) inside this folder if your script uses any for storing settings and alike.

Modinfo.ini Example:

[Mod Info]
name = My Awesome Script
version = 1.0
author = Username
description = This mod adds awesome functionality to the game.
screenshot = thumbnail.png

[Options]
category = Scripts
addonfor = [Main Mod Name]
requirement = [Required Mod Name]

Zipping the Mod:

Once your folder structure is set, zip the entire MyModName folder. Ensure that the zipped file contains the modinfo.ini, thumbnail.png, and the reframework/autorun/ folder with your Lua script inside.

Adding a Thumbnail:

1. Create an image in PNG/JPEG format.
2. Name the file thumbnail.png.
3. Place the thumbnail.png file in the root of your mod folder, alongside the modinfo.ini file.

When users browse mods in Fluffy Mod Manager, this image will appear as the thumbnail for your mod.