Files
FalsePatternLib/README.MD
T

31 lines
3.7 KiB
Markdown
Raw Permalink Normal View History

2022-05-08 19:49:20 +02:00
A library mod for 1.7.10 with lots of useful stuff. See the table below for more information.
2022-06-08 16:01:12 +02:00
| 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 |
2022-06-10 00:15:14 +02:00
| [updates](src/main/java/com/falsepattern/lib/updates) | Helper code for update checking |
2022-05-26 23:08:45 -07:00
| [util](src/main/java/com/falsepattern/lib/util) | Additional utilities that do not fit the above categories, see below for more information |
2022-05-08 19:49:20 +02:00
The contents of the [util](src/main/java/com/falsepattern/lib/util) package so far:
2022-06-12 11:56:22 +02:00
| Class | Purpose |
|---------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------|
| [AsyncUtil](src/main/java/com/falsepattern/lib/util/AsyncUtil.java) | Asynchronous execution 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 |
2022-03-11 23:19:37 +01:00
2022-05-08 19:49:20 +02:00
Anything annotated with [@StableAPI](src/main/java/com/falsepattern/lib/StableAPI.java) is guaranteed to not change in patch versions.
2022-03-11 23:19:37 +01:00
2022-06-11 14:49:20 +02:00
The update checker module and the library downloader module can be toggled with the `ENABLE_UPDATE_CHECKER` and
2022-06-10 00:15:14 +02:00
`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
2022-06-11 14:49:20 +02:00
on disk, disabling the library loader breaks the update checker. This is only required the first time download, though.
2022-06-10 00:15:14 +02:00
2022-03-11 23:19:37 +01:00
### This project WILL NOT be ported to any version beyond 1.7.10, don't even ask
2022-05-22 00:03:58 +02:00
2022-05-26 23:08:45 -07:00
[![POOP badge](https://raw.githubusercontent.com/gist/poop-person/991e80f390384bbeef09d208bff208f4/raw/a9ef83add84a70f2202896c2d81117ff7b169be1/poop-badge.svg)](https://gist.github.com/poop-person/991e80f390384bbeef09d208bff208f4)