JfMods/Respackopts
JfMods
/
Respackopts
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

[docs] Omit unneeded quotes around entry names

This commit is contained in:
Johannes Frohnmeyer 2022-06-07 23:23:14 +02:00
parent 08ee11ae45
commit ec3587977d
Signed by: Johannes
GPG Key ID: E76429612C2929F4
9 changed files with 118 additions and 118 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
docs/AdvancedConfig.md
View File

@ -18,15 +18,15 @@ They also require a minimum and maximum value to be specified.
### Example:
```json
{
"id": "examplePack",
"version": 6,
"capabilities": ["FileFilter", "DirFilter"],
"conf": {
"someOption": {
"type": "slider", // can also be "number" for a normal number
"default": 5,
"min": 0,
"max": 10
id: "examplePack",
version: 6,
capabilities: ["FileFilter", "DirFilter"],
conf: {
someOption: {
type: "slider", // can also be "number" for a normal number
default: 5,
min: 0,
max: 10
}
}
}
@ -44,14 +44,14 @@ Their type is `enum`
### Example:
```json
{
"id": "examplePack",
"version": 6,
"capabilities": ["FileFilter", "DirFilter"],
"conf": {
"someOption": {
"type": "enum",
"default": "Second",
"values": ["First", "Second", "Third"]
id: "examplePack",
version: 6,
capabilities: ["FileFilter", "DirFilter"],
conf: {
someOption: {
type: "enum",
default: "Second",
values: ["First", "Second", "Third"]
}
}
}

76
docs/MainConfig.md
View File

@ -14,10 +14,10 @@ You can add [translations](./Translations.md) to work around this in the UI show
### What needs to be here.
```json
{
"id": "<PackID>",
"version": 8,
"capabilities": ["FileFilter", "DirFilter"],
"conf": {
id: "<PackID>",
version: 8,
capabilities: ["FileFilter", "DirFilter"],
conf: {
// Your config options here
}
}
@ -36,12 +36,12 @@ To add a boolean entry, add code like this: `"entryName": <Default Option (true/
### Example:
```json
{
"id": "examplePack",
"version": 8,
"capabilities": ["FileFilter", "DirFilter"],
"conf": {
"someTexture": true,
"someOtherTexture": false
id: "examplePack",
version: 8,
capabilities: ["FileFilter", "DirFilter"],
conf: {
someTexture: true,
someOtherTexture: false
}
}
```
@ -57,11 +57,11 @@ A number box follows the same principle as a boolean: `"entryName": Default Numb
### Example:
```json
{
"id": "examplePack",
"version": 8,
"capabilities": ["FileFilter", "DirFilter"],
"conf": {
"someOption": 10
id: "examplePack",
version: 8,
capabilities: ["FileFilter", "DirFilter"],
conf: {
someOption: 10
}
}
```
@ -78,11 +78,11 @@ To allow users to select one entry from a list, you can use a json array with st
### Example:
```json
{
"id": "examplePack",
"version": 8,
"capabilities": ["FileFilter", "DirFilter"],
"conf": {
"someOption": [
id: "examplePack",
version: 8,
capabilities: ["FileFilter", "DirFilter"],
conf: {
someOption: [
"optionOne",
"optionTwo",
"optionThree"
@ -98,27 +98,27 @@ To allow users to select one entry from a list, you can use a json array with st
### Example:
```json
{
"id": "examplePack",
"version": 8,
"capabilities": ["FileFilter", "DirFilter"],
"conf": {
"someCategory": {
"someBoleanOption": true,
"someNumberOption": 5,
"someSelectionOption": [
"optionOne",
"optionTwo",
"optionThree"
id: "examplePack",
version: 8,
capabilities: ["FileFilter", "DirFilter"],
conf: {
someCategory: {
someBoleanOption: true,
someNumberOption: 5,
someSelectionOption: [
optionOne,
optionTwo,
optionThree
],
"someSliderOption": {
"min": 0,
"default": 5,
"max": 10
someSliderOption: {
min: 0,
default: 5,
max: 10
}
},
"someotherCategory": {
"someOtherBoleanOption": true,
"someOtherNumberOption": 5
someotherCategory: {
someOtherBoleanOption: true,
someOtherNumberOption: 5
}
}
}

16
docs/MultipleFileSelection.md
View File

@ -20,31 +20,31 @@ if you have 4 files to select between then you will need 3 `.rpo` files and so o
This is your first `.rpo` with your first file:
```json
{
"condition": "<your entry>",
"fallback": "path/to/second.json/.png"
condition: "<your entry>",
fallback: "path/to/second.json/.png"
}
```
This is your second `.rpo` with your second file:
```json
{
"condition": "<your entry>",
"fallback": "path/to/thirdfile.json/.png"
condition: "<your entry>",
fallback: "path/to/thirdfile.json/.png"
}
```
### Example:
```json
{
"condition": "option_one",
"fallback": "path/to/secondfile.json"
condition: "option_one",
fallback: "path/to/secondfile.json"
}
```
```json
{
"condition": "option_two",
"fallback": "path/to/thirdfile.json"
condition: "option_two",
fallback: "path/to/thirdfile.json"
}
```

30
docs/ResourceExpansion.md
View File

@ -14,14 +14,14 @@ For example, the following is a valid script: `'Text ' || (someNumber * 15) || s
conf.json:
```json
{
"id": "examplePack",
"version": 6,
"capabilities": ["FileFilter", "DirFilter"],
"conf": {
"oakFence": {
"uvLock": true,
"invertOrientation": false,
"yFactor": 0
id: "examplePack",
version: 6,
capabilities: ["FileFilter", "DirFilter"],
conf: {
oakFence: {
uvLock: true,
invertOrientation: false,
yFactor: 0
}
}
}
@ -29,13 +29,13 @@ conf.json:
oak_fence.json.rpo:
```json
{
"expansions": {
"uvlock": "examplePack.oakFence.uvLock",
"orientation": "!examplePack.oakFence.invertOrientation",
"y000": "examplePack.oakFence.yFactor + 0",
"y090": "examplePack.oakFence.yFactor + 90",
"y180": "examplePack.oakFence.yFactor + 180",
"y270": "examplePack.oakFence.yFactor + 270"
expansions: {
uvlock: "examplePack.oakFence.uvLock",
orientation: "!examplePack.oakFence.invertOrientation",
y000: "examplePack.oakFence.yFactor + 0",
y090: "examplePack.oakFence.yFactor + 90",
y180: "examplePack.oakFence.yFactor + 180",
y270: "examplePack.oakFence.yFactor + 270"
}
}
```

6
docs/ToggleFiles.md
View File

@ -16,13 +16,13 @@ You will need to navigate to the file you would like to toggle inside your resou
### Layout:
```json
{
"condition": "<entry name>"
condition: "<entry name>"
}
```
### Example:
```json
{
"condition": "someTexture"
condition: "someTexture"
}
```
@ -33,7 +33,7 @@ Directories ("Folders") can also be toggled without toggling individual files.
To do this, create a file in the directory you want to toggle titled `.rpo` (no file name).
Both conditions and fallbacks work like they do on files, however, specifying multiple fallbacks
for a directory will not work. In some cases, you may need to add `"DirFilterAdditive"`
to your `"capabilities"` inside your conf.json for fallbacks to work as expected.
to your `capabilities` inside your conf.json for fallbacks to work as expected.
Please be aware that you should NOT specify it unless you are SURE you need it, as it will worsen performance.
See [Switch between two files](./ToggleFilesWithFallback.md) to see how to swap textures out with each other (alternate Options)

14
docs/ToggleFilesWithFallback.md
View File

@ -16,15 +16,15 @@ You will need to navigate to the file you would like to toggle inside your resou
### Layout:
```json
{
"condition": "<entry name>",
"fallback": "location/of/the/file"
condition: "<entry name>",
fallback: "location/of/the/file"
}
```
### Example:
```json
{
"condition": "someTexture",
"fallback": "assets/minecraft/textures/example/alternate.png"
condition: "someTexture",
fallback: "assets/minecraft/textures/example/alternate.png"
}
```
@ -33,8 +33,8 @@ Respackopts supports specifying multiple possible fallbacks when configuring sin
You can use this functionality as follows:
```json
{
"condition": "<entry name>",
"fallbacks": [
condition: "<entry name>",
fallbacks: [
"location/of/the/file",
"assets/minecraft/textures/example/alternate.png"
]
@ -43,7 +43,7 @@ You can use this functionality as follows:
```json
{
"condition": "someTexture"
condition: "someTexture"
}
```

4
run/resourcepacks/testpack/assets/minecraft/lang/.rpo
View File

@ -1,4 +1,4 @@
{
"conditions": "false",
"fallback": "assets/minecraft/langer"
conditions: "false",
fallback: "assets/minecraft/langer"
}

2
run/resourcepacks/testpack/assets/minecraft/langer/de_de.json.rpo
View File

@ -1,3 +1,3 @@
{
"fallbacks": "assets/minecraft/lang/en_us_joke.json"
fallbacks: "assets/minecraft/lang/en_us_joke.json"
}

54
run/resourcepacks/testpack/assets/respackopts/conf.json
View File

@ -1,48 +1,48 @@
{
"id": "lumi",
"version": 8,
"capabilities": ["FileFilter", "DirFilter", "DirFilterAdditive"],
"conf": {
"tonemap": [
id: "lumi",
version: 8,
capabilities: ["FileFilter", "DirFilter", "DirFilterAdditive"],
conf: {
tonemap: [
"default",
"vibrant",
"film"
],
"pbr": {
"type": "boolean",
"default": true,
"reloadType": "Simple"
pbr: {
type: "boolean",
default: true,
reloadType: "Simple"
},
"debugMode": [
debugMode: [
"none",
"normal",
"viewDir"
],
"waterVertexWavy": false,
"numTest": 15.4,
"oakFence": {
"uvLock": true,
"invertOrientation": false,
"yFactor": 0
waterVertexWavy: false,
numTest: 15.4,
oakFence: {
uvLock: true,
invertOrientation: false,
yFactor: 0
},
"subcategoryTest": {
"thisIsCool": true,
"numberInSub": 15,
"enumInSub": [
subcategoryTest: {
thisIsCool: true,
numberInSub: 15,
enumInSub: [
"zthis is default",
"yay1",
"yay2",
"yay3",
"athis is last"
],
"sliderTest": {
"min": 15,
"default": 16,
"max": 20
sliderTest: {
min: 15,
default: 16,
max: 20
},
"enableLang": true,
"enableLangForceDisable": false,
"enableLangJokeFallback": true
enableLang: true,
enableLangForceDisable: false,
enableLangJokeFallback: true
}
}
}