Skip to content

Commit 980e8a8

Browse files
committed
[ci skip] update readme with the new stuff
1 parent 0f5ab90 commit 980e8a8

File tree

1 file changed

+13
-8
lines changed

1 file changed

+13
-8
lines changed

README.MD

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -2,25 +2,30 @@ A library for 1.7.10 with lots of useful stuff, licensed under the LGPL3.0+SNEED
22

33
| Package | Contents / Purpose |
44
|-----------------------------------------------------------------|-------------------------------------------------------------------------------------------|
5+
| [asm](src/main/java/com/falsepattern/lib/asm) | ASM helper code |
56
| [compat](src/main/java/com/falsepattern/lib/compat) | Code backported from vanilla 1.12.2 |
67
| [config](src/main/java/com/falsepattern/lib/config) | 1.12.2-style annotation-based config library |
78
| [dependencies](src/main/java/com/falsepattern/lib/dependencies) | Runtime dependency loader which uses Maven |
9+
| [mapping](src/main/java/com/falsepattern/lib/mapping) | Notch-SRG-MCP name mapping helper code |
810
| [mixin](src/main/java/com/falsepattern/lib/mixin) | Mixin loader plugin boilerplate code |
911
| [text](src/main/java/com/falsepattern/lib/text) | Better Chat and GUI text processing |
12+
| [toasts](src/main/java/com/falsepattern/lib/toasts) | The toast system from newer versions, with some extras |
1013
| [updates](src/main/java/com/falsepattern/lib/updates) | Helper code for update checking |
1114
| [util](src/main/java/com/falsepattern/lib/util) | Additional utilities that do not fit the above categories, see below for more information |
1215

1316
The contents of the [util](src/main/java/com/falsepattern/lib/util) package so far:
1417

15-
| Class | Purpose |
16-
|---------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------|
17-
| [FileUtil](src/main/java/com/falsepattern/lib/util/FileUtil.java) | Directory and file utilities. |
18-
| [LangUtil](src/main/java/com/falsepattern/lib/util/LangUtil.java) | Utility for having default language values defined inside code instead of lang files |
19-
| [MathUtil](src/main/java/com/falsepattern/lib/util/MathUtil.java) | Miscellaneous math helper code |
20-
| [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 |
21-
| [ResourceUtil](src/main/java/com/falsepattern/lib/util/ResourceUtil.java) | Methods for efficiently retrieving resources from SPECIFIC jar files instead of the entire classpath |
18+
| Class | Purpose |
19+
|------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------|
20+
| [FileUtil](src/main/java/com/falsepattern/lib/util/FileUtil.java) | Directory and file utilities. |
21+
| [LangUtil](src/main/java/com/falsepattern/lib/util/LangUtil.java) | Utility for having default language values defined inside code instead of lang files |
22+
| [MathUtil](src/main/java/com/falsepattern/lib/util/MathUtil.java) | Miscellaneous math helper code |
23+
| [ReflectionUtl](src/main/java/com/falsepattern/lib/util/ReflectionUtil.java) | Reflection helper code |
24+
| [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 |
25+
| [ResourceUtil](src/main/java/com/falsepattern/lib/util/ResourceUtil.java) | Methods for efficiently retrieving resources from SPECIFIC jar files instead of the entire classpath |
2226

23-
Anything annotated with [@StableAPI](src/main/java/com/falsepattern/lib/StableAPI.java) is guaranteed to not change in patch versions.
27+
See the [@StableAPI](src/main/java/com/falsepattern/lib/StableAPI.java) annotation's javadoc for more information about
28+
API stability.
2429

2530
The update checker module and the library downloader module can be toggled with the `ENABLE_UPDATE_CHECKER` and
2631
`ENABLE_LIBRARY_DOWNLOADS` booleans in the `falsepatternlib.cfg` config file respectively. Note that the update checker

0 commit comments

Comments
 (0)