[root] update README
All checks were successful
ci/woodpecker/push/docs Pipeline was successful
ci/woodpecker/push/jfmod Pipeline was successful

This commit is contained in:
Johannes Frohnmeyer 2023-03-18 11:09:34 +01:00
parent 457c1f4d85
commit 2a7ad29431
Signed by: Johannes
GPG Key ID: E76429612C2929F4

View File

@ -1,10 +1,16 @@
LibJF is a library for my smaller mods which contains a config system and common code.
LibJF is a library for my smaller mods which contains several common components.
Namely it provides:
- a complete config system with UIs, commands, compile-time codegen, presets, verifiers, etc
- a framework for manipulating loaded data and resources
- two new tags (which you can also use in data packs):
- `libjf:overpowered`: if an entity only wears armor items with this tag, it will become invulnerable
- `libjf:shulker_boxes_illegal`: items with this tag cannot be placed inside shulker boxes.
Intended to be used for backpacks or similar items
- utility code for serialization, script loading, co-processes, IO, etc.
- network utilities including a HTTP client and server
- a configurable and extensible translation system supporting various providers
- utilities for early initialization and ASM patching
If one of my mods depends on this, it will be mentioned in its page.
Apart from useful classes for mods, LibJF also adds two new item tags:
- `raut:overpowered`: if an entity only wears armor items with this tag, it will become invulnerable
- `raut:shulker_boxes_illegal`: items with this tag cannot be placed inside shulker boxes.
Intended to be used for backpacks or similar items
If a mod is made by me, it is generally safe to assume it requires LibJF (or ships with parts of it)
If you want to use LibJF yourself, you can find documentation [here](https://pages.frohnmeyer-wds.de/JfMods/LibJF/)