From c49bf13d46c9b6b11e4cd12dd25ac606dd379531 Mon Sep 17 00:00:00 2001 From: FalsePattern <30945458+FalsePattern@users.noreply.github.com> Date: Fri, 10 Jun 2022 00:15:14 +0200 Subject: [PATCH] update readme --- README.MD | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.MD b/README.MD index 32f1d75..3c7a3da 100644 --- a/README.MD +++ b/README.MD @@ -7,6 +7,7 @@ A library mod for 1.7.10 with lots of useful stuff. See the table below for more | [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: @@ -18,6 +19,11 @@ The contents of the [util](src/main/java/com/falsepattern/lib/util) package so f 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 checker 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 though. + ### This project WILL NOT be ported to any version beyond 1.7.10, don't even ask [![POOP badge](https://raw.githubusercontent.com/gist/poop-person/991e80f390384bbeef09d208bff208f4/raw/a9ef83add84a70f2202896c2d81117ff7b169be1/poop-badge.svg)](https://gist.github.com/poop-person/991e80f390384bbeef09d208bff208f4)