Update README.md
This commit is contained in:
parent
8dd950fe05
commit
3ffea8b00b
|
@ -5,7 +5,8 @@ An example for the frex/canvas integration can be found [here](https://gitlab.co
|
||||||
|
|
||||||
# Using Respackopts
|
# Using Respackopts
|
||||||
## Users
|
## Users
|
||||||
You will just need to install Respackopts. A menu button will appear besides all supported resourcepacks.
|
You will just need to install Respackopts. A menu button will appear besides all supported resourcepacks.\
|
||||||
|
You can get the latest version [here](https://gitlab.com/JFronny/respackopts/-/jobs/artifacts/master/raw/latest.jar?job=deploy)
|
||||||
## Resource pack authors
|
## Resource pack authors
|
||||||
You will need to define a respackopts conf as seen [here](https://gitlab.com/JFronny/respackopts/-/blob/master/run/resourcepacks/lumi/assets/respackopts/conf.json)
|
You will need to define a respackopts conf as seen [here](https://gitlab.com/JFronny/respackopts/-/blob/master/run/resourcepacks/lumi/assets/respackopts/conf.json)
|
||||||
|
|
||||||
|
@ -21,7 +22,7 @@ The following things can be changed:
|
||||||
- Enum keys: `respackopts.field.{packId}.{entryId}.{enumKey}`
|
- Enum keys: `respackopts.field.{packId}.{entryId}.{enumKey}`
|
||||||
- Config titles: `respackopts.title.{packId}`
|
- Config titles: `respackopts.title.{packId}`
|
||||||
|
|
||||||
Please note that translations require your resource pack to be loaded
|
Please note that translations require your resource pack to be loaded.
|
||||||
|
|
||||||
The version property defines the format version. It will be incremented if changes to the layout of the config are made\
|
The version property defines the format version. It will be incremented if changes to the layout of the config are made\
|
||||||
I will likely attempt to support older versions if I decide to make an incompatible change.\
|
I will likely attempt to support older versions if I decide to make an incompatible change.\
|
||||||
|
@ -42,4 +43,5 @@ To save information, call `Respackopts.save()`, `Respackopts.load()` to load.
|
||||||
`boolVals`, `numVals`, `strVals` and `enumKeys` use the resource pack ID as their first key,
|
`boolVals`, `numVals`, `strVals` and `enumKeys` use the resource pack ID as their first key,
|
||||||
then the property name. After that you get the value. Enums are expressed as numbers with enum key names in enumKeys.\
|
then the property name. After that you get the value. Enums are expressed as numbers with enum key names in enumKeys.\
|
||||||
If you need code to be ran after changes are made to the state, add an action to `saveActions`.\
|
If you need code to be ran after changes are made to the state, add an action to `saveActions`.\
|
||||||
This is currently used for the Canvas/FREX integration, which uses it to generate shader code.
|
This is currently used for the Canvas/FREX integration, which uses it to generate shader code.\
|
||||||
|
The config GUI is currently generated using cloth config. The config icon ís loaded from ModMenu. It will not display if that is not loaded.
|
Loading…
Reference in New Issue
Block a user