Skip to content

Commit fa2b3e4

Browse files
committed
improve readme
1 parent 51995e6 commit fa2b3e4

File tree

1 file changed

+17
-5
lines changed

1 file changed

+17
-5
lines changed

README.MD

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,23 @@
1-
A library used by some of my other mods.
2-
31
CurseForge: https://www.curseforge.com/minecraft/mc-mods/falsepatternlib
42

5-
The primary feature of this mod is version-safe dependency handling of non-mod libraries. FalsePatternLib can dynamically load dependencies from a specific maven repository, which lets mods that use external dependencies to share said dependency, instead of shadowing it in for each individual mod. This leads to way smaller jar files, and an extremely low chance of dependency conflicts.
3+
A library mod for 1.7.10 with lots of useful stuff. See the table below for more information.
4+
5+
| Package | Stuff it has |
6+
|-----------------------------------------------------------------|-----------------------------------------------------------------|
7+
| [compat](src/main/java/com/falsepattern/lib/compat) | Code backported from vanilla 1.12.2. |
8+
| [config](src/main/java/com/falsepattern/lib/config) | 1.12.2-style annotation-based config library |
9+
| [dependencies](src/main/java/com/falsepattern/lib/dependencies) | Runtime dependency loader. Uses Maven. |
10+
| [mixin](src/main/java/com/falsepattern/lib/mixin) | Mixin loader plugin boilerplate code |
11+
| [text](src/main/java/com/falsepattern/lib/text) | Better Chat and GUI text processing |
12+
| [util](src/main/java/com/falsepattern/lib/util) | Additional stuff that don't fit the above categories. See below |
13+
14+
The contents of the [util](src/main/java/com/falsepattern/lib/util) package so far:
15+
16+
| Class | What it does |
17+
|--------------|----------------------------------------------------------------------------------------------------------------|
18+
| ResourceUtil | Provides methods for efficiently retrieving resources from SPECIFIC jar files, instead of the entire classpath |
619

7-
Dependencies:
820

9-
None
21+
Anything annotated with [@StableAPI](src/main/java/com/falsepattern/lib/StableAPI.java) is guaranteed to not change in patch versions.
1022

1123
### This project WILL NOT be ported to any version beyond 1.7.10, don't even ask

0 commit comments

Comments
 (0)