59 lines
2.1 KiB
Markdown
59 lines
2.1 KiB
Markdown
# Advanced config entries
|
|
|
|
## Common info
|
|
Every advanced entry will be represented as a json object.
|
|
Every entry can contain the following properties, regardless of its type:
|
|
|
|
| Name | Required | Description |
|
|
|------------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------|
|
|
| type | yes | The type of the entries. Each one can contain specific info, more on that below |
|
|
| default | yes | The default value for this entry. This is what you would specify in a normal config entry (except for enums, where this is just the default entries name) |
|
|
| reloadType | no | `"Resource"` or `"Simple"`, specifies whether resources have to be reloaded if this is changed. Frex shaders will be reloaded anyways |
|
|
|
|
## Numbers
|
|
There are two ways to display numbers: input boxes and sliders.
|
|
Any number input that provides a minimum and maximum value will be displayed as a slider instead of a box.
|
|
|
|
### Example:
|
|
```json
|
|
{
|
|
id: "examplePack",
|
|
version: 9,
|
|
capabilities: ["FileFilter", "DirFilter"],
|
|
conf: {
|
|
someOption: {
|
|
default: 5,
|
|
min: 0,
|
|
max: 10
|
|
}
|
|
}
|
|
}
|
|
```
|
|
### Result:
|
|
|
|
|
|
## Booleans/Toggles
|
|
These do not expose any additional options, look under `Common info`. Their type is `boolean`
|
|
|
|
## Enum entries/Selecting from a list
|
|
The possible values for this entry will be under `values`, while the `default` value will just be a string.
|
|
Their type is `enum`
|
|
|
|
### Example:
|
|
```json
|
|
{
|
|
id: "examplePack",
|
|
version: 9,
|
|
capabilities: ["FileFilter", "DirFilter"],
|
|
conf: {
|
|
someOption: {
|
|
type: "enum",
|
|
default: "Second",
|
|
values: ["First", "Second", "Third"]
|
|
}
|
|
}
|
|
}
|
|
```
|
|
### Result:
|
|
|