Skip to content

Commit a36316a

Browse files
Update aur release to use aksh1618/update-aur-package
Update README.md
1 parent 9929937 commit a36316a

File tree

2 files changed

+19
-8
lines changed

2 files changed

+19
-8
lines changed

.github/workflows/release.yml

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -76,18 +76,16 @@ jobs:
7676
run: echo "TAG=$(git describe --tags --abbrev=0)" >> $GITHUB_ENV
7777

7878
- name: Update no-gui AUR package
79-
uses: ATiltedTree/create-aur-release@v1
79+
uses: aksh1618/update-aur-package@v1
8080
with:
8181
package_name: ferium-bin
82-
package_version: ${{ env.TAG }}
8382
commit_username: "Ilesh Thiada"
8483
commit_email: [email protected]
8584
ssh_private_key: ${{ secrets.AUR_SSH_PRIVATE_KEY }}
8685
- name: Update gui AUR package
87-
uses: ATiltedTree/create-aur-release@v1
86+
uses: aksh1618/update-aur-package@v1
8887
with:
8988
package_name: ferium-gui-bin
90-
package_version: ${{ env.TAG }}
9189
commit_username: "Ilesh Thiada"
9290
commit_email: [email protected]
9391
ssh_private_key: ${{ secrets.AUR_SSH_PRIVATE_KEY }}

README.md

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@ You can change this in 2 ways, setting the `FERIUM_CONFIG_FILE` environment vari
150150
The flag always takes precedence.
151151

152152
> [!CAUTION]
153-
> Be careful when manually editing the config file
153+
> Be mindful of syntax when manually editing the config file
154154
155155
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.
156156
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
165165
- [Add a modpack](#adding-modpacks) by running `ferium modpack add <project_id>`.
166166
- After which, run `ferium modpack upgrade` to download and install the latest version of the modpack.
167167

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
169181

170182
> [!TIP]
171183
> 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
189201
```bash
190202
ferium add owner/name
191203
```
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.
193205
So to add [Sodium](https://github.com/CaffeineMC/sodium-fabric), you should run `ferium add CaffeineMC/sodium-fabric` (again, case-insensitive).
206+
194207
> [!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.
196209
197210
#### User Mods
198211

0 commit comments

Comments
 (0)