Skip to content

Commit d5bd3b8

Browse files
Update libium README.md
1 parent fa8a82b commit d5bd3b8

1 file changed

Lines changed: 10 additions & 6 deletions

File tree

libium/README.md

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,15 @@
11
# Libium
22

3+
> [!IMPORTANT]
4+
> This project used to be in its [own repository](https://github.com/gorilla-devs/libium), but it has now been moved into ferium's repository to make pull requests and dependency syncing easier.
5+
> You will need to go to the old repository to see the commit history.
6+
37
Libium is the backend of [ferium](https://github.com/gorilla-devs/ferium). It helps manage Minecraft mods from Modrinth, CurseForge, and Github Releases.
48

5-
These are the main components of libium;
9+
This is a brief description of the main components of libium
610

7-
- `config` deals with (surprise, surprise) the config. It defines the config structure and methods to get the config file, deserialise it, etc
8-
- `modpack` contains manifest/metadata structs for MR and CF modpack formats, and functions for reading these from a zip file
9-
- `upgrade` contains functions for fetching the latest compatible mod/modpack file, and downloading it
10-
- `add` contains functions to verify and add a mod to a profile
11-
- `file_picker` contains functions to show a file picker for both GUI and CLI styles
11+
- `config` defines the config structure and methods to get the config file, deserialise it, upgrade it to a new version, etc.
12+
- `modpack` contains manifest/metadata structs for Modrinth and CurseForge modpack formats, reads these from a zip file, and adds modpacks to configs.
13+
- `upgrade` defines and implements filters, and fetches the latest compatible mod/modpack file, and downloads it.
14+
- `add` verifies and adds a mod to a profile.
15+
- `scan` hashes mod files in a directory and sends them to the Modrinth and CurseForge APIs to retrieve mod information and add them to a profile.

0 commit comments

Comments
 (0)