Skip to content

mod.json

Every mod has a mod.json at its top. Unknown fields are ignored with a note, so a manifest written for a newer game still loads.

mod.json
{
"id": "solar_flare",
"name": "Solar Flare",
"version": "1.0.0",
"api_version": 1,
"author": "you",
"description": "One line for the mods list."
}
Field Type Rule
id string required Lower case letters, digits and _; starts with a letter; 2 to 32 characters. Not nukeislands base game forge mod mods. Two folders with the same id never run together.
name string required 1 to 40 characters. The MODS list shows it.
version string required MAJOR.MINOR.PATCH, three whole numbers.
api_version integer required The mod API you wrote for. This game implements level 1. Newer is refused; older but supported loads with a warning.
description string One line for the MODS list. Cut at 400 characters.
author string Cut at 80 characters.
homepage string A link.
license string For example CC0-1.0 or MIT.
requires object { "other_mod": "1.2.0" }: mods you need, with the oldest version you accept. Missing, too old or broken means your mod does not load.
load_after array Mod ids that load before yours if present. Order only; it does not require them.
conflicts array Mod ids that cannot run with yours. The one that would load later is switched off.
priority integer -1000 to 1000, default 0. Lower loads first. Ties go to the id, A to Z. The player’s order in the MODS list comes first.
side string both (default), server or client: where your script runs. Data, strings and files apply in both VMs either way.
entry string Script to run, default main.luau. A main.luauc next to it wins. No .., not absolute.
overrides boolean true lets the mod replace base game files by path. Replaced Luau runs with full access, outside the sandbox. Default false.

This game implements mod API level 1 and accepts mods written for levels 1 to 1.

  • Above the game’s level: refused.
  • Below the oldest supported level: refused.
  • Below the game’s level but supported: loads, with a warning in the MODS list.

Adding a function, event, kind or field does not raise the level. Removing one, or changing what it means, does, and the game keeps accepting the previous level for as long as it can.

mod.json
{
"id": "big_guns",
"name": "Big Guns",
"version": "2.1.0",
"api_version": 1,
"author": "you",
"description": "Heavier ships and a louder Silo.",
"homepage": "https://example.com/big_guns",
"license": "MIT",
"requires": { "solar_flare": "1.0.0" },
"load_after": ["some_mod"],
"conflicts": ["tiny_guns"],
"priority": 10,
"side": "both"
}