Making a Minecraft mod

Minecraft mods on Nebula are ordinary Fabric, Quilt, Forge or NeoForge mods (.jar), and server plugins for Paper and its relatives. You do not change how you build them. For what Nebula does with a mod in general, see How Nebula delivers mods.

Overview

  • A Minecraft server on Nebula has a Minecraft setup: which version, which mod loader, and which build of it. Players get exactly that, installed for them by the launcher.
  • Mods you upload must be built for the loader you pick. Nebula reads the loader from the jar's own descriptor and only delivers mods that run on it.
  • A server that runs the Nebula Server agent gets its mods through the agent too, and keeps its whitelist in step with Nebula.

Loaders

LoaderDescriptor Nebula reads
Fabricfabric.mod.json
Quiltquilt.mod.json
ForgeMETA-INF/mods.toml
NeoForgeMETA-INF/neoforge.mods.toml

The list of loaders and their versions is read from the loaders' own sources, so new ones appear without a Nebula update. A jar with several descriptors can run on several loaders.

Uploading

Upload the .jar on the server's Mods page, or add a mod straight from Modrinth (Nebula downloads it, checks its hash, and adds its required dependencies as libraries). The name, version, mod id and what it requires are read from the descriptor.

Minecraft setup

On a Minecraft server's Overview, set the Minecraft version, the mod loader (and optionally an exact loader build; the default is the newest stable) and the server address. The launcher then prepares Minecraft, the right Java and the loader for each whitelisted player, sends the mods, and can join the server by itself.

Client, server or both

A mod that only does something on a player's game (a map, a shader helper) should say so, so Nebula does not put it on the server: "environment": "client" in fabric.mod.json, or the Nebula manifest line described in the Secure mods page. A mod that adds blocks, items or logic needs to be on both sides.

Secure mods

Mark a mod Secure (only runs under Nebula) or Secure+ (client-side, never given to a server) in the jar's manifest. See Secure and Secure+ Minecraft mods.