Ferium Tutorial

2023/10/25

Ferium is a CLI program that allows you to easily manage your Minecraft mods. It stores your modlist in $HOME/.config/ferium/config.json, handles dependencies, and automatically fetches the most up to date release for your version. This guide is aimed at Windows users.

Installation

To install Ferium on Windows, I recommend using Scoop, a package manager for Windows. This will add Ferium to your PATH automatically. To install Scoop, open PowerShell and run:

Set-ExecutionPolicy RemoteSigned -Scope CurrentUser
irm get.scoop.sh | iex

Then, to install Ferium with Scoop, run these commands:

scoop bucket add games
scoop install ferium

Now, you should be able to run the ferium command.

Create a profile

Create a profile with

ferium profile create

It will guide you through the process. If you use the official Minecraft launcher, you don’t need to specify a custom mods directory. If you use MultiMC or a third-party launcher, you will.

When you’re done with the wizard, the aforementioned $HOME/.config/ferium/config.json will be created. This stores the profile (the version, path, and all the mods it contains). If there is an update to the game, you can update the game_version attribute in this file to the new version.

Add a mod

Now, to add a mod to your profile (and its dependencies), run:

ferium add <mod>

where <mod> is the identifier for the mod on Modrinth. The identifier is the string that appears after the last slash (/) in the URL for a mod. For example, to add Sodium (https://modrinth.com/mod/sodium) to your profile:

ferium add sodium

To remove a mod, run

ferium remove "<Mod Name>"

e.g.

ferium remove "Sodium"

then the mod will be removed from your mods folder the next time you run ferium upgrade.

Fetch / update mods

Now the mod(s) you added should be listed in your config.json. But it hasn’t actually downloaded the jarfiles for your mods yet. To do so, run

ferium upgrade

and it will fetch all the mods in your profile and ensure they are up to date.

Before you launch the game, make sure you have a mod loader installed. You probably want to use Fabric, which you can download and install here. You can use the Windows installer if you don’t have Java.


That’s about it. Happy modding.