You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+17-4Lines changed: 17 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -150,7 +150,7 @@ You can change this in 2 ways, setting the `FERIUM_CONFIG_FILE` environment vari
150
150
The flag always takes precedence.
151
151
152
152
> [!CAUTION]
153
-
> Be careful when manually editing the config file
153
+
> Be mindful of syntax when manually editing the config file
154
154
155
155
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` global flags respectively.
156
156
Again, the flags take precedence.
@@ -165,7 +165,19 @@ You can either have your own set of mods in what is called a 'profile', or insta
165
165
-[Add a modpack](#adding-modpacks) by running `ferium modpack add <project_id>`.
166
166
- After which, run `ferium modpack upgrade` to download and install the latest version of the modpack.
167
167
168
-
### Adding Mods
168
+
### Automatically Import Mods
169
+
170
+
```bash
171
+
ferium scan
172
+
```
173
+
174
+
This command scans a directory with mods, and attempts to add them to your profile.
175
+
176
+
The directory defaults to your profile's output directory. Some mods are available on both Modrinth and CurseForge; ferium will prefer Modrinth by default, but you can choose CurseForge instead using the `--platform` flag.
177
+
178
+
As long as you ensure the mods in the directory match the configured mod loader and Minecraft version, they should all add properly. Some mods might require some [additional tuning](#check-overrides). You can also bypass the compatibility checks using the `--force` flag.
179
+
180
+
### Manually Adding Mods
169
181
170
182
> [!TIP]
171
183
> You can specify multiple identifiers to add multiple mods at once
@@ -189,10 +201,11 @@ So to add [Terralith](https://www.curseforge.com/minecraft/mc-mods/terralith), y
189
201
```bash
190
202
ferium add owner/name
191
203
```
192
-
`owner` is the username of the owner of the repository and `name` is the name of the repository, both are case-insensitive. (e.g. [Sodium's repository](https://github.com/CaffeineMC/sodium-fabric) has the id `CaffeineMC/sodium-fabric`). You can find these at the top left of the repository's page as a big 'owner / name'.
204
+
`owner` is the username of the owner of the repository and `name` is the name of the repository, both are case-insensitive. (e.g. [Sodium's repository](https://github.com/CaffeineMC/sodium-fabric) has the id `CaffeineMC/sodium-fabric`). You can find these at the top left of the repository's page.
193
205
So to add [Sodium](https://github.com/CaffeineMC/sodium-fabric), you should run `ferium add CaffeineMC/sodium-fabric` (again, case-insensitive).
206
+
194
207
> [!IMPORTANT]
195
-
> The GitHub repository needs to upload JAR files to their Releases for ferium to download, or else it will refuse to be added.
208
+
> The GitHub repository needs to upload JAR files to their _Releases_ for ferium to download, or else it will refuse to be added.
0 commit comments