Check out Ferium's sister projects Ferinth and Furse. They're Rust wrappers for the Modrinth and CurseForge APIs respectively
Ferium is a fast and feature rich 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.
- Download mods from multiple sources, namely Modrinth, CurseForge, and GitHub Releases
- Pleasing and beautiful UI
- Super fast downloads due to multi-threading for network intensive tasks
- You can configure the maximum number of additional threads using the
--threadsoptions
- You can configure the maximum number of additional threads using the
- 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
- You can configure overrides for mods that are not specified as compatible but still work
- Create multiple profiles and configure different mod loaders, Minecraft versions, output directories, and mods for each
Ferium is a compiled, statically linked program that does not require external dependencies.
However, Rust programs in general do require gcc-libs to be installed.
On Linux the regular version requires GTK, but the no-gui version does not need this.
Ferium is coming to more package managers soon! Tracking Issue
- No GUI
- No GUI from Source (installs the Rust toolchain)
- GUI File Dialogue (depends on GTK)
- GUI File Dialogue from Source (install the Rust toolchain and depends on GTK)
Ferium is available here in Scoop's official games bucket.
Run scoop bucket add games then scoop install ferium to install.
If you have the Rust toolchain installed, you can compile and install Ferium from source by running cargo install ferium.
Remember to use an add-on like cargo-update to keep Ferium updated to the latest version!
- Download the asset suitable for your operating system from the latest release
- Unzip the file and move it to a folder in your path, e.g.
~/bin - Remember to check the releases page for any updates!
Note! A lot of Ferium's backend is in a seperate project Libium. It deals with things such as the config, adding mods, upgrading mods, file pickers, etc
The config file is located at
~/.config/ferium/config.jsonif you're interested in manually editing it
When you first start up Ferium, you will have to create a new profile by running ferium profile create and entering the details for your profile.
- Modrinth Mods
ferium add-modrinth project_id- Where
project_idis the slug or project id of the mod- For example, Sodium has the slug
sodiumand a project idAANobbMI - 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'
- For example, Sodium has the slug
- So to add Sodium, you should run
ferium add-modrinth sodiumorferium add-modrinth AANobbMI
- CurseForge Mods
- GitHub 'Mods'
ferium add-github owner/name- Where
owneris the username of the owner of the repository andnameis the name of the repository (both case-insensitive)- For example Sodium's repository has the id
CaffeineMCandsodium-fabric - You can find these at the top left part of the repository's page as a big 'owner / name'
- For example Sodium's repository has the id
- 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 use files that are not downloadable by Ferium, place them in the
userfolder in the output directory. Files here will be copied to the output directory when upgrading
- If you want to use files that are not downloadable by Ferium, place them in the
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 download a mod, it will print it's name in red and give the reason. It will continue downloading the rest of the mods and will exit with an error.
WARNING: When upgrading, any files not downloaded by Ferium will be moved to the .old folder in the output directory
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 mods 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).
If some mod is compatible with your profile but Ferium does not download it, create an issue if you think it's a bug. You can disable the game version or mod loader checks by using the --dont-check-game-version and/or --dont-check-mod-loader flags when adding the mod, or manually setting check_game_version or check_mod_loader to false for the specific mod in the config.
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
{
"name": "Just Enough Items (JEI)",
"identifier": {
"CurseForgeProject": 238222
},
"check_mod_loader": false
}You can create a profile by running ferium profile create and configuring the following:
- Output directory
- This defaults to
.minecraft/modswhere.minecraftis 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)
- This defaults to
- Name of the profile
- Minecraft version
- Mod loader
You can also provide these settings as flags.
If you want to copy the mods from another profile, provide the --import flag. You can also directly provide a profile name to the flag if you don't want a profile picker will be shown.
Ferium will automatically switch to the newly created profile.
You can configure those same settings afterwards by running ferium profile configure.
Again, you can provide these settings as flags.
You can see all the profiles you have by running ferium profile list.
Switch between your profiles using ferium switch.
Delete a profile by running ferium profile delete and selecting the profile you want to delete.
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.
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, it's basically a much better version of make.
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-nogui for building binaries that don't need GTK, they will not have a GUI file dialogue.
You can run clippy lints using just lint, integration tests using cargo test, and delete all the build and test artefacts using just clean.