Skip to content

Commit a266377

Browse files
committed
Documentation update
1 parent 0f6fd9d commit a266377

7 files changed

Lines changed: 13 additions & 7 deletions

File tree

glass-config-api-v3/docs/Adding.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22

33
You want to use GCAPI to handle your mod config? Great!
44

5-
You already have GCAPI in your workspace if you have [StationAPI](../../wiki/Setting-up-workspace). For the next steps, see [Using](Using.md).
5+
You already have GCAPI in your workspace if you have [StationAPI](../../wiki/Setting-up-workspace). For the next steps, see [Using](Using.md).

glass-config-api-v3/docs/Home.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,6 @@
66

77
[TODO for GCAPI](Todo.md)
88

9-
[Migrating from 1.0 to 2.0](Migration1.0.md)
9+
[Migrating from 1.0 to 2.0](Migration1.0.md)
10+
11+
[Migrating from 2.0 to 3.0](Migration2.0.md)

glass-config-api-v3/docs/Migration1.0.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,4 +36,4 @@ CHANGED:
3636
- `init(Screen,TextRenderer)V` no longer handles adding icons indicating server sync.
3737
- `PreConfigSavedListener` and `PostConfigLoadedListener`
3838
- A new `source` parameter was added.
39-
- See `EventStorage.EventSource` for more information.
39+
- See `EventStorage.EventSource` for more information.

glass-config-api-v3/docs/Migration2.0.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,8 @@ Most breaking changes are package changes, and annotation changes, with only one
66

77
- `@ConfigEntry` and `@ConfigCategory` now house all information about the field is on, removing the need for checking for 6 different annotations on load.
88
- `@GConfig` had it's `primary` value removed, and instead replaced with `priority`.
9-
-
9+
- All packages have changed to properly follow StationAPI's project structure.
10+
- Config verification has been moved from clientside classes, and is now applied whenever a config value is loaded.
11+
- Added a new optional field to `ConfigEntry`: `textValidator`. This will be used by default on any custom config types, unless `isValid` is overridden.
12+
- Array types now require `getTypedArray` to be overridden due to java type parameter shenanigans.
13+
- `@ConfigEntry` and `@ConfigCategory` can now use translation keys in their names and descriptions.

glass-config-api-v3/docs/Todo.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,4 @@ Mostly for me. In rough order of priority weighted with estimated difficulty.
55
2. Add the ability to easily and cleanly edit config fields programmatically.
66
3. Add support for colours with an ingame colour picker. Adding an actual colour picker might be a pain the the arse. I have a couple of ideas on how to do this.
77
4. Add field validation on game load. JSON files are not validated on load, currently.
8-
5. Add block and item selection support. Should be easy enough with StAPI registries. I currently cannot think of a good use for this config option yet, though.
8+
5. Add block and item selection support. Should be easy enough with StAPI registries. I currently cannot think of a good use for this config option yet, though.

glass-config-api-v3/docs/Types.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,4 @@ The built-in factories are as follows:
1313
- java.lang.Float[]
1414
- [java.lang.Enum](Using.md#enums)
1515

16-
Should this list ever fall out of date, see [DefaultFactoryProvider.java](../blob/master/src/main/java/net/glasslauncher/mods/api/gcapi/impl/config/factory/DefaultFactoryProvider.java).
16+
Should this list ever fall out of date, see [DefaultFactoryProvider.java](../blob/master/src/main/java/net/glasslauncher/mods/api/gcapi/impl/config/factory/DefaultFactoryProvider.java).

glass-config-api-v3/docs/Using.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,4 +59,4 @@ Make your config category class, implement `GeneratedConfig`.
5959

6060
- Use `GCAPI.reloadConfig` to manually set config values. This is to ensure mods are notified properly and can post-process things.
6161
- The config.json files are not sanitised or checked when loaded. This will be fixed in a later update once I figure out a good way to handle it. This is low on my list.
62-
- Servers are able to send whatever configs they want, so long as the config field on the client is MP syncable. The server doesn't even need to have the mod installed. This would require emulating GCAPI's config export code to do so, though. I'm not sure if I'll patch this. It seems like it would have its uses.
62+
- Servers are able to send whatever configs they want, so long as the config field on the client is MP syncable. The server doesn't even need to have the mod installed. This would require emulating GCAPI's config export code to do so, though. I'm not sure if I'll patch this. It seems like it would have its uses.

0 commit comments

Comments
 (0)