Ferium

Check out Ferium's sister projects Ferinth and Furse which are Rust libraries to use the Modrinth and CurseForge APIs respectively

Ferium is an easy to use CLI program for downloading and updating Minecraft mods from Modrinth, CurseForge, and GitHub Releases. Simply specify the mods you use through the CLI and in just one command, you can download all the mods you configured.

Features

• Download mods from multiple sources, namely Modrinth, CurseForge, and GitHub Releases
• Upgrade all your mods in one command, ferium upgrade
  • Ferium checks that the version being downloaded is the latest one compatible with the chosen mod loader and Minecraft version
• Create multiple profiles and configure different mod loaders, Minecraft versions, output directories, and mods for each
• Configure overrides for mods that are not specified as compatible, but still work

Installation

Ferium is a compiled, statically linked program that does not require any external dependencies. On Linux the regular version requires GTK to be installed, but the no-gui version does not need this.

Ferium is coming to more package managers soon! Tracking Issue

AUR

Ferium releases a no-gui version here and a version with a GUI file dialog here. The GUI version dependes on GTK

Cargo Install

If you have the Rust toolchain, you can also compile and install Ferium by running cargo install ferium.

Remember to use an add-on like cargo-update to keep Ferium updated to the latest version!

GitHub Releases

1. Download the asset suitable for your operating system from the latest release
2. Unzip the file and move it to a folder in your path such as ~/bin
3. Remember to check the releases page for any updates!

Overview / Help Page

Note! A lot of Ferium's backend is in a seperate project Libium. It has things like the config, add, upgrade, file pickers, etc

The config file is located at ~/.config/ferium/config.json if you're interested in manually editing it

First Startup

When you first start up, you will have to create a new profile by running ferium profile create and entering the details for your profile.

Adding Mods

• Modrinth Mods
  • ferium add-modrinth project_id
  • Where project_id is the slug or project id of the mod
  • For example, Sodium has the slug sodium and a project id AANobbMI
  • You can find the slug in the website url (modrinth.com/mod/<slug>), and the project id at the bottom of the left sidebar under 'Technical information'
  • So to add Sodium, you should run ferium add-modrinth sodium or ferium add-modrinth AANobbMI
• CurseForge Mods
  • ferium add-curseforge project_id
  • Where project_id is the project id of the mod
  • For example, Terralith has a project id 513688
  • You can find the project id at the top of the right sidebar under 'About Project'
  • So to add Terralith, you should run ferium add-curseforge 513688
• GitHub 'Mods'
  • ferium add-github owner name
  • Where owner is the username of the owner of the repository and name is the name of the repository (both case-insensitive)
  • For example Sodium's repository has the id CaffeineMC and sodium-fabric
  • You can find these at the top left part of the repository's page as a big 'owner / name'
  • So to add Sodium, you should run ferium add-github CaffeineMC sodium-fabric (again, case-insensitive)
  • Note: The GitHub repository has to release JAR files in their Releases for Ferium to download, or else it will refuse to be added
• External mods
  • If you want to add files that are not on Modrinth, CurseForge, or GitHub Release, place them in a user folder in the output directory. Files here will be copied to the output directory when upgrading

Upgrading Mods

If your output directory is not empty when setting it, Ferium will offer to create a backup. Please do so if it contains any files you would like to keep

Now after adding all your mods, run ferium upgrade to download all of them to your output directory. This defaults to .minecraft/mods, where .minecraft is the default Minecraft resources directory. You don't need to worry about this if you play with Mojang's launcher (unless you changed the resources directory). You can choose to pick a custom output directory during profile creation or change it later.

If Ferium fails to find a compatible version of a mod, it will print it's name in red and give a reason.It will continue downloading the rest of the mods and will exit with an error. See the advanced section for more information.

WARNING: When upgrading, any files not downloaded by Ferium will be moved to the .old folder in the output directory

Managing Mods

You can see all the mods in your current profile by running ferium list. If you want to see more information about them, you can run ferium list -v or ferium list --verbose.

You can remove any of your mod by runnning ferium remove, selecting the ones you would like to remove by using the space key, and pressing enter once you're done. You can also provide the names of the mods to remove as arguments. Mod names with spaces have to be given in quotes (ferium remove "ok zoomer") or the spaces should be escaped (ferium remove ok\ zoomer).

Check Overrides

If some mod is compatible with your profile but Ferium does not download it, create an issue if you think it's a bug. Or else, you can disable the game version or mod loader checks by setting check_game_version or check_mod_loader to false for the specific mod.

For example, Just Enough Items does not specify the mod loader for older minecraft versions such as 1.12.2. In this case, you would add JEI by running ferium add-curseforge 238222 --dont-check-mod-loader so that the mod loader check is disabled. You can also manually disable the mod loader (and/or game version) check(s) in the config like so json { "name": "Just Enough Items (JEI)", "identifier": { "CurseForgeProject": 238222 }, "check_mod_loader": false }

Profiles

Create

You can create a profile by running ferium profile create and configuring the following settings:

• Output directory
  • This defaults to .minecraft/mods where .minecraft is the default Minecraft resources directory. You don't need to worry about this if you play with Mojang's launcher (unless you changed the resources directory)
• Name of the profile
• Minecraft version
• Mod loader

You can also provide these settings as flags to the create command. If you want to copy the mods from another profile, provide the --import flag. You can also provide the profile name to the --import flag if you don't a profile picker will be shown. Finally, Ferium will automatically switch to the newly created profile.

Configure

You can configure these same settings afterwards by running ferium profile configure. Again, you can provide these settings as flags to the command.

Manage

You can see all the profiles you have by running ferium profile list. Switch between your profiles using ferium switch.

Delete

You can delete a profile by running ferium profile delete and selecting the profile you want to delete.

Feature Requests

If you would like to make a feature request, check the issues to see if the feature has already been added or is planned. If not, create a new issue.

Building from Source or Working with Ferium

Firstly, you need the Rust toolchain which includes cargo, rustup, etc. You can install these from the Rust website. You'll also need the Just command runner, its basically a much better version of make.

If you want to build Ferium without cloning the repo, set the CURSEFORGE_API_KEY environment variable, then run cargo install ferium. If you don't have a CurseForge API key, you can set the variable to an empty value. However anything using the CurseForge API will not work.

To build the project and install it to your Cargo binary directory, clone the project and run just install. If you want to install it for testing a developement version, run just (alias for just install-dev).

If you want to obtain executables for a specific OS, you can run just build-<OS> and replace <OS> with mac, win, or linux. The produced binaries will be zipped and moved to out/. There is also just build-linux-noguifor building binaries that don't need GTK.

You can run clippy linters using just lint, and integration tests using cargo test. Finally you can delete all the build and test artefacts by using just clean.