Skip to content

Commit

Permalink
Added a bit more info on broken paths
Browse files Browse the repository at this point in the history
Closes #67
  • Loading branch information
SHsuperCM committed Nov 19, 2021
1 parent 4d4118c commit abf0721
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 3 deletions.
4 changes: 2 additions & 2 deletions docs/usage/config.md
Expand Up @@ -5,7 +5,7 @@
The config is located at `%appdata%/.minecraft/config/citresewn.json`.

If you have [Cloth Config](https://www.curseforge.com/minecraft/mc-mods/cloth-config) installed,
run `/citresewn config` or if you have [Mod Menu](https://www.curseforge.com/minecraft/mc-mods/modmenu)
run `/citresewn config` and if you have [Mod Menu](https://www.curseforge.com/minecraft/mc-mods/modmenu)
installed, in the main menu/pause screen go to `Mods > CIT Resewn > Config`.

## Config Values
Expand All @@ -16,4 +16,4 @@ installed, in the main menu/pause screen go to `Mods > CIT Resewn > Config`.
| `Mute Errors` <br>or `mute_errors` | Should cit errors be muted in the logs. | `false` |
| `Mute Warns` <br>or `mute_warns` | Should cit warnings be muted in the logs. | `false` |
| `Cache` <br>or `cache_ms` | How often should the cache be refreshed. <br>If set to 0, caching will be disabled. | `50`ms(every tick) |
| `Broken Paths` <br>or `broken_paths` | Should CIT Resewn be able to read broken folder/file names from CIT packs | `false` |
| `Broken Paths` <br>or `broken_paths` | Should CIT Resewn be able to read broken folder/file names from CIT packs. This option is unstable and not recommended, any bugs it causes will be ignored. <br><br> Broken Paths are any files in a resourcepack that do not follow standard minecraft pack formatting. The pack format permits names for files and folders that may only contain the following: lower case english alphabet(`a-z`), any number(`0-9`), underscores(`_`), dots(`.`) and dashes(`-`). | `false` |
4 changes: 3 additions & 1 deletion docs/usage/help.md
Expand Up @@ -11,7 +11,9 @@ Check the logs, they are more useful than you think!

### Non [a-z0-9/._-] character in path of location:
The resourcepack you're using is not following minecraft's pack formatting standards.
Contact the pack author and inform them. In the mean time you can enable broken paths in the config (try to avoid doing this please).
Contact the pack author and inform them.

For more information on Broken Paths, read the [Broken Paths section in the config docs](/usage/config).

### Anything else:
Feel free to open an [Issue](https://github.com/SHsuperCM/CITResewn/issues) or DM @SHsuperCM on the Fabric discord server for anything CIT Resewn!

0 comments on commit abf0721

Please sign in to comment.