Files
FalsePatternLib/README.MD
T
2022-07-29 17:44:04 +02:00

28 lines
3.4 KiB
Markdown

A library for 1.7.10 with lots of useful stuff, licensed under the LGPL3.0+SNEED license.
| Package | Contents / Purpose |
|-----------------------------------------------------------------|-------------------------------------------------------------------------------------------|
| [compat](src/main/java/com/falsepattern/lib/compat) | Code backported from vanilla 1.12.2 |
| [config](src/main/java/com/falsepattern/lib/config) | 1.12.2-style annotation-based config library |
| [dependencies](src/main/java/com/falsepattern/lib/dependencies) | Runtime dependency loader which uses Maven |
| [mixin](src/main/java/com/falsepattern/lib/mixin) | Mixin loader plugin boilerplate code |
| [text](src/main/java/com/falsepattern/lib/text) | Better Chat and GUI text processing |
| [updates](src/main/java/com/falsepattern/lib/updates) | Helper code for update checking |
| [util](src/main/java/com/falsepattern/lib/util) | Additional utilities that do not fit the above categories, see below for more information |
The contents of the [util](src/main/java/com/falsepattern/lib/util) package so far:
| Class | Purpose |
|---------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------|
| [FileUtil](src/main/java/com/falsepattern/lib/util/FileUtil.java) | Directory and file utilities. |
| [LangUtil](src/main/java/com/falsepattern/lib/util/LangUtil.java) | Utility for having default language values defined inside code instead of lang files |
| [RenderUtil](src/main/java/com/falsepattern/lib/util/RenderUtil.java) | Rendering tools. Currently, the only thing implemented is a way to grab the current partial tick time from the minecraft instance |
| [ResourceUtil](src/main/java/com/falsepattern/lib/util/ResourceUtil.java) | Methods for efficiently retrieving resources from SPECIFIC jar files instead of the entire classpath |
Anything annotated with [@StableAPI](src/main/java/com/falsepattern/lib/StableAPI.java) is guaranteed to not change in patch versions.
The update checker module and the library downloader module can be toggled with the `ENABLE_UPDATE_CHECKER` and
`ENABLE_LIBRARY_DOWNLOADS` booleans in the `falsepatternlib.cfg` config file respectively. Note that the update checker
depends on the module downloader to grab [FJson](https://github.com/FalsePattern/FJson), so if it's not already present
on disk, disabling the library loader breaks the update checker. This is only required the first time download, though.