JfMods/LibJF
JfMods/LibJF
1
1
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

docs: remove link to nowhere
All checks were successful
ci/woodpecker/push/vitepress Pipeline was successful
Details
ci/woodpecker/push/jfmod Pipeline was successful
Details

Browse Source
This commit is contained in:
Johannes Frohnmeyer 2024-09-30 18:06:34 +02:00
parent e84137dd8d
commit c015071742
Signed by: Johannes
GPG Key ID: E76429612C2929F4
1 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/config/libjf-config-compiler-plugin-v2.md
View File

@ -1,8 +1,14 @@
# libjf-config-compiler-plugin-v2 # libjf-config-compiler-plugin-v2
This annotation processor provides finds classes annotated with `@JfConfig` and produces the necessary code and registration for them. This annotation processor provides finds classes annotated with `@JfConfig` and produces the necessary code and registration for them.
Using this is the recommended way to use libjf-config. Using this is the recommended way to use libjf-config.
Please be aware that the restrictions of [the reflection implementation](./libjf-config-reflect-v1.md) in regard to class loading
will also apply to configs using the plugin if it is loaded during runtime. ::: warning
If `libjf-unsafe` is present, configs may be accessed early.
This can lead to issues if your config class accesses other classes that are not yet intended to be accessed.
Make sure to only access classes that are safe to access early (e.g. JDK classes).
:::
Please note that your `fabric.mod.json` must reference the generated class, not your original config. Please note that your `fabric.mod.json` must reference the generated class, not your original config.
If you plan on accessing your config before `onInitialize`, it is recommended that you call `.ensureInitialized()` on your If you plan on accessing your config before `onInitialize`, it is recommended that you call `.ensureInitialized()` on your