Install Plugins

Before you start

SoulFire plugins are Fabric mods. See Plugins for the architecture behind that.
Built-in plugins are already shipped with SoulFire. You only need to enable them.
Community plugins must be added as .jar files and loaded at startup.

For the current built-in list, see Built-in Plugins.

If you want to build your own plugin rather than install an existing jar, use the Development section. That is the correct path for advanced Fabric-plugin work, Mixins, and low-level SoulFire integrations.

Enable a built-in plugin

Open the instance

Open the instance where you want the plugin to run.

Enable the plugin

Open Plugins and turn on the built-in plugin you want to use.

Configure it if needed

Open Plugin Settings to change any options exposed by that plugin.

Start or restart the session

Start the instance, or restart it if you changed settings that only apply on startup.

Install a community plugin

Get a compatible Fabric mod `.jar`

Use a SoulFire-specific plugin or a Fabric mod that is compatible with SoulFire's non-rendering environment.

Place it in the mods directory

Put the .jar file in minecraft/mods.

Integrated server (GUI/CLI): Open Help -> Data directory, then go to soulfire/minecraft/mods
Dedicated server: Use the minecraft/mods directory next to the server .jar

Restart SoulFire

New Fabric mods are loaded on startup, so restart the relevant SoulFire server after adding the file.

Compatibility notes

Mods that require rendering, audio, or other client-only features usually do not work.
Mods that change networking, automation, inventory behavior, or other game logic are more likely to work.
A plugin can use Mixins and deep integration points, so only install plugins you trust.

Plugins for the Fabric-based plugin model
Development for authoring your own plugin
Built-in Plugins for the shipped plugin list
Resources for community plugins and scripts

On this page