Respackopts/docs/filerpo/ToggleFiles.md

40 lines
1.5 KiB
Markdown
Raw Normal View History

2021-09-15 15:17:32 +02:00
# Toggle Files
A condition can be looked at like an `IF` statement simply returning true/false to configure whether the texture/file should be loaded into the pack.
2021-08-30 14:38:03 +02:00
(Turns the texture "on" or "off").
You will need the `Pack ID` and `Entry Name` from your `respackopts.json5` that you created earlier
2022-08-30 13:31:08 +02:00
if you have not, see [Main Config](../setup/MainConfig.md) on how to do so.
2021-08-30 14:38:03 +02:00
<br>
You will need to navigate to the file you would like to toggle inside your resource, and create a `.rpo` file for it in the same folder(directory).
<br>
### Examples:
`texture.png` would be `texture.png.rpo`<br>
2021-08-30 15:03:33 +02:00
`recipe.json` would be `recipe.json.rpo`
2021-08-30 14:38:03 +02:00
<br>
### Layout:
```json
{
condition: "<entry name>"
2021-08-30 14:38:03 +02:00
}
```
### Example:
```json
{
condition: "someTexture"
2021-08-30 14:38:03 +02:00
}
```
2022-08-30 13:31:08 +02:00
For more information on conditions, [read this](../additional/AdvancedConditions.md)
### Toggle Directories
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 respackopts.json5 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.
2021-09-15 15:17:32 +02:00
See [Switch between two files](./ToggleFilesWithFallback.md) to see how to swap textures out with each other (alternate Options)