upstream/FalsePatternLib
2
0 Fork 0
mirror of https://github.com/FalsePattern/FalsePatternLib.git synced 2026-11-12 00:17:49 +00:00
Code Issues Packages Projects Releases Wiki Activity

[ci skip] update readme with the new stuff

Browse Source
This commit is contained in:
FalsePattern committed 2022-07-31 20:53:02 +02:00
1 parent 0f5ab90f95
commit 980e8a8776
1 file changed
+13 -8
Download Patch File Download Diff File Expand all files Collapse all files
README.MD
+13 -8
View File
@@ -2,25 +2,30 @@ A library for 1.7.10 with lots of useful stuff, licensed under the LGPL3.0+SNEED
| Package | Contents / Purpose |
|-----------------------------------------------------------------|-------------------------------------------------------------------------------------------|
| [asm](src/main/java/com/falsepattern/lib/asm) | ASM helper code |
| [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 |
| [mapping](src/main/java/com/falsepattern/lib/mapping) | Notch-SRG-MCP name mapping helper code |
| [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 |
| [toasts](src/main/java/com/falsepattern/lib/toasts) | The toast system from newer versions, with some extras |
| [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 |
| [MathUtil](src/main/java/com/falsepattern/lib/util/MathUtil.java) | Miscellaneous math helper code |
| [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 |
| 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 |
| [MathUtil](src/main/java/com/falsepattern/lib/util/MathUtil.java) | Miscellaneous math helper code |
| [ReflectionUtl](src/main/java/com/falsepattern/lib/util/ReflectionUtil.java) | Reflection helper code |
| [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.
See the [@StableAPI](src/main/java/com/falsepattern/lib/StableAPI.java) annotation's javadoc for more information about
API stability.
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