Respackopts/docs/MainConfig.md
2021-08-30 15:03:33 +02:00

3.2 KiB

ResourcePackOpts Config.

Location (ResourcePacks).

/assets/respackopts/conf.json

Location (DataPacks).

/data/respackopts/conf.json

What needs to be here.

{
    "id": "<PackID>",
    "version": 5,
    "capabilities": ["FileFilter", "DirFilter"],
    "conf": {
        // Your config options here
    }
}

Capabilities:

FileFilter: (Default Enabled)
If stated will enable file filtering functionality.

DirFilter: (Default Disabled)
If stated will enable folder filtering functionality.

DirFilterAdditive: (Default Disabled)
If stated this will enable a compatibility fix for some mods that also modify resources.

Adding a Toggle/Boolean

To add a boolean entry, add code like this: "entryName": <Default Option (true/false)>

Example:

{
    "id": "examplePack",
    "version": 5,
    "capabilities": ["FileFilter", "DirFilter"],
    "conf": {
        "someTexture": true,
        "someOtherTexture": false
    }
}

Result:

configExampleBoolean

See ToggleFiles to see the logic behind this

Adding a Free Number Box

A number box follows the same principle as a boolean: "entryName": Default Number please note any value can be put in here with no limit

Example:

{
    "id": "examplePack",
    "version": 5,
    "capabilities": ["FileFilter", "DirFilter"],
    "conf": {
        "someOption": 10
    }
}

Result:

configExampleNumber

Adding a slider

A slider is slightly more complicated as a minimum and a maximum need to be defined. Sliders also only support whole numbers.

Example:

{
    "id": "examplePack",
    "version": 5,
    "capabilities": ["FileFilter", "DirFilter"],
    "conf": {
        "someOption": {
            "min": 0,
            "default": 5,
            "max": 10
        }
    }
}

Result:

configExampleSlider

Select From a list

To allow users to select one entry from a list, you can use a json array with string entries. Numbers/etc are not supported

Example:

{
    "id": "examplePack",
    "version": 5,
    "capabilities": ["FileFilter", "DirFilter"],
    "conf": {
        "someOption": [
            "optionOne",
            "optionTwo",
            "optionThree"
        ]
    }
}

Result:

configExampleEnum

Make a category

Example:

{
    "id": "examplePack",
    "version": 5,
    "capabilities": ["FileFilter", "DirFilter"],
    "conf": {
        "someCategory": {
            "someBoleanOption": true,
            "someNumberOption": 5,
            "someSelectionOption": [
                "optionOne",
                "optionTwo",
                "optionThree"
           ],
            "someSliderOption": {
                "min": 0,
                "default": 5,
                "max": 10
            }
        },
        "someotherCategory": {
            "someOtherBoleanOption": true,
            "someOtherNumberOption": 5
        }
    }
}

Result:

configExampleCategory