You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/doc/docs/config/index.md
+6-2Lines changed: 6 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,16 +1,20 @@
1
1
# Config GUI
2
2
3
-
The config GUI is the main selling point of MoulConfig.
3
+
The config GUI is the main selling point of MoulConfig. It can be manually constructed using a [`ConfigStructureReader` subclass](../javadocs/common/io.github.notenoughupdates.moulconfig.processor/-config-structure-reader/index.html),
4
+
or by using [`ConfigProcessorDriver`](../javadocs/common/io.github.notenoughupdates.moulconfig.processor/-config-processor-driver/index.html) or the [`ManagedConfig` (for full automation of config saving and displaying)](../javadocs/common/io.github.notenoughupdates.moulconfig.managed/-managed-config/index.html)
4
5
5
6
## Structure
6
7
7
8
The config structure is roughly mapped to Java classes. Each category, subcategory and accordion is its own Java object.
8
9
9
-
The base class needs to extend `Config` and each field needs to be non-static. This way your config is also easily
10
+
The base class needs to extend [`Config`](../javadocs/common/io.github.notenoughupdates.moulconfig/-config/index.html) and each field needs to be non-static. This way your config is also easily
10
11
serializable as a Json Object. MoulConfig is however completely agnostic towards your configs save format. The only
11
12
requirement is that instances do not get reassigned. So updating the config object after you have processed a config
12
13
requires that config to be reprocessed (and old MoulConfig to be discarded).
13
14
15
+
If you specifically do want MoulConfig to load and save files for you, consider obtaining the instance of your config
16
+
through [`ManagedConfig`](../javadocs/common/io.github.notenoughupdates.moulconfig.managed/-managed-config/index.html)
the [TestMod](https://github.com/NotEnoughUpdates/MoulConfig/blob/master/modern/src/main/kotlin/io/github/notenoughupdates/moulconfig/test)
92
+
the [FabricMain](https://github.com/NotEnoughUpdates/MoulConfig/blob/v4/modern/templates/java/io/github/notenoughupdates/moulconfig/test/FabricMain.java)
92
93
for usage examples, or check out the annotation
93
94
package documentation to see the kind of config variable editors MoulConfig has built in.
0 commit comments