Skip to content

Commit

Permalink
0.2.0 readme updates
Browse files Browse the repository at this point in the history
  • Loading branch information
AnOpenSauceDev authored Jan 4, 2024
1 parent 762b1bf commit 89a4f61
Showing 1 changed file with 13 additions and 4 deletions.
17 changes: 13 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,21 @@

A pretty tiny mod that checks the hashes of every mod in your mods folder against Modrinth to see if the mod you're using is tamper-free.

Works as long **as you have less than 300 _individual (.jar file)_ mods** (because you'll get rate-limited going past that.)
Works as long **as you have less than 300 _individual (.jar file)_ mods** (because you'll get rate-limited going past that, also assuming this is the first run.)

Due to this mod using the Modrinth API, this will fail checks on binaries from CurseForge/Github that aren't identical to what's on Modrinth.

This mod is very much in its infancy, with quite a bit of work still to go.

**TODO:**
- Cache results in a **secure** way to not send nearly as many API calls.
- ~~multithread everything~~ Done!
## Caching System

As of 0.2.0, the ITML will resolve to one of two hash "databases"
- `~/.minecraft/config/ITML.cache`
- Modrinth's "version from hash" API.

After verifying a hash with the Modrinth API, the mod's hash will be stored over in `ITML.cache`, of which any hashes located in there will be whitelisted (with a notice in the logger itself.)
This essentially means that there should only be a noticable increase in load times when opening a **large** modpack for the first time.

This also means that you only need to connect to the internet once at startup to verify your mods, and to recconnect when you add/update any mods.

To rebuild the cache, just delete the file, nothing will break.

0 comments on commit 89a4f61

Please sign in to comment.