Skip to content

Mod Setup

Noah edited this page Sep 1, 2023 · 5 revisions

On this page we'll explain how to create your first mod.

Mod Template

We recommend using our vscode-mod-template for an easy quick-start.

Directory Structure

To start off, create a folder in <GameDirectory>/mods.
The folder name does not matter, however it should generally have the same name as your mod.

Then create the following files:

πŸ“‚ C:/GOG Games/Coromon
└── mods
    └── my_awesome_mod
        β”œβ”€β”€ config.json
        └── init.lua

config.json

This file contains important information about your mod.
The required fields and appropriate descriptions are described by this schema.

Note

Our mod-template has auto-complete support for the config.json

init.lua

This file contains the actual code of your mod, you can go ahead and implement your awesome mod here.
For more information on special functions, et cetera see Lua Environment

Clone this wiki locally