From 2a7ad294310a7c03fefc15ca0d93a3d7020290ee Mon Sep 17 00:00:00 2001 From: JFronny Date: Sat, 18 Mar 2023 11:09:34 +0100 Subject: [PATCH] [root] update README --- README.md | 20 +++++++++++++------- 1 file changed, 13 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index a344bcf..02dd322 100644 --- a/README.md +++ b/README.md @@ -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/)