Check out ferium's sister projects ferinth and furse. They are Rust wrappers for the official 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, and modpacks from Modrinth and CurseForge. Simply specify the mods or modpacks you use through the CLI, and in just one command you can download all the mods or the modpack you configured.
https://user-images.githubusercontent.com/60034030/201951498-62d1e6d9-8edb-4399-b02c-f2562ae566e3.mp4
ferium upgrade
ferium modpack upgradeFerium is a compiled, statically linked program that does not require external dependencies.
On Linux, the regular version requires some sort of desktop environment that offers an XDG Desktop Portal. The nogui versions do not need this.
Ferium is coming to more package managers soon! Tracking Issue
From source builds will install the Rust toolchain. GUI builds require any XDG compatible desktop environment to be available at runtime.
Available here in the core formulae repository.
Run brew install ferium to install.
Available here in Scoop's official games bucket.
Run scoop bucket add games then scoop install ferium to install.
Available here
Run pacstall -I ferium-bin to install.
Available here in the unstable channel.
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!
~/binNote! A lot of ferium's backend is in a separate project libium. It deals with things such as the config, adding mod(pack)s, upgrading, file pickers, etc
Ferium stores profile and modpack information in its config file. By default it is located at ~/.config/ferium/config.json, but you can change this in 2 ways. You can set the FERIUM_CONFIG_FILE environment variable or set the --config-file global command flag, the flag always takes precedence.
You can also set a custom CurseForge API key or GitHub personal access token using the CURSEFORGE_API_KEY and GITHUB_TOKEN environment variables or the --curseforge_api_key and --github-token flags respectively. Again, the flags take precedence.
You can either have your own set of mods in what is called a 'profile', or install a modpack.
ferium profile create and entering the details for your profile
ferium addferium upgradeferium modpack add <project_id>
ferium modpack upgrade to download and install the modpackferium add project_idproject_id is the slug or project id of the modsodium and a project id AANobbMImodrinth.com/mod/<slug>), and the project id at the bottom of the left sidebar under 'Technical information'ferium add sodium or ferium add AANobbMIferium add owner/nameowner is the username of the owner of the repository and name is the name of the repository (both case-insensitive)CaffeineMC/sodium-fabricferium add CaffeineMC/sodium-fabric (again, case-insensitive)user folder in the output directory. Files here will be copied to the output directory when upgradingferium modpack add project_idproject_id is the slug or project id of the modpackbetter-minecraft and a project id shFhR8Vxmodrinth.com/modpack/<slug>), and the project id at the bottom of the left sidebar under 'Technical information'ferium modpack add better-minecraft or ferium modpack add shFhR8VxIf 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 its 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
If your output directory's
modsandresourcepacksare 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 modpack upgrade to download the modpack to your output directory.
This defaults to .minecraft, which 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 when adding modpacks or change it later.
If ferium fails to download a mod, it will print its name in red and give the reason. It will continue downloading the rest of the mods and will exit with an error.
WARNING: If you choose to install modpack overrides, your existing configs may be overwritten
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 running 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 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
}
When adding a modpack, you will configure the following:
.minecraft, which 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 also provide these settings as flags. Ferium will automatically switch to the newly added modpack.
You can configure these same settings afterwards by running ferium modpack configure.
Again, you can provide these settings as flags.
You can see all the modpack you have configured by running ferium modpack list.
Switch between your modpacks using ferium modpack switch.
Delete a profile by running ferium modpack delete and selecting the modpack you want to delete.
You can create a profile by running ferium profile create and configuring the following:
.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 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 to 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 profile 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, which is 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 development version, run just (alias for just install-dev).
If you want to obtain executables for specific targets, you can run just build-<target> and replace <target> with mac-intel, mac-arm win, win-gnu, linux, or linux-nogui. The produced binaries will be zipped and moved to out/. just build-linux-nogui is for building binaries that don't need GTK, but 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.