Remove backslashes from docs

This commit is contained in:
JFronny 2021-09-14 19:46:33 +02:00
parent dfbc52625c
commit 4eeba10343
No known key found for this signature in database
GPG Key ID: BEC5ACBBD4EE17E5
5 changed files with 10 additions and 9 deletions

View File

@ -1,8 +1,8 @@
# ResourcePackOpts Config.
### Before we begin
Any pack id or config entry name MUST only contain alphabetical characters (no numbers, spaces, underscores, etc) and SHOULD be in [camelCase](https://en.wikipedia.org/wiki/Camel_case).\
If that is not the case, you may face unexpected issues.\
Any pack id or config entry name MUST only contain alphabetical characters (no numbers, spaces, underscores, etc) and SHOULD be in [camelCase](https://en.wikipedia.org/wiki/Camel_case).
If that is not the case, you may face unexpected issues.
You can add [translations](./Translations.md) to work around this in the UI shown to users though.
### Location (ResourcePacks).

View File

@ -1,5 +1,5 @@
# ResPackOpts Home
Here is everything you need to know about configuring your resource with respackopts.\
Here is everything you need to know about configuring your resource with respackopts.
Some pages may not have been updated, you can view those [here](old/)
### Compatibility

View File

@ -1,9 +1,9 @@
# Translating your config
Adding a translation file to your pack can not only be used to translate your content, it also enables you to change the way entries are displayed in the config screen without changing your actual config.\
Adding a translation file to your pack can not only be used to translate your content, it also enables you to change the way entries are displayed in the config screen without changing your actual config.
NOTE: translations added like this will only be shown if the resource pack containing them is loaded.
## Creating a lang file
Respackopts relies on minecrafts built-in system for translations. This means that you can add them to the normal `assets/minecraft/lang/en_us.json` file in which minecrafts on translations reside.\
Respackopts relies on minecrafts built-in system for translations. This means that you can add them to the normal `assets/minecraft/lang/en_us.json` file in which minecrafts on translations reside.
An empty translation file will look like this:
```json
{
@ -31,7 +31,7 @@ This works similarly to changing the title, however, the name of the entry is ap
This example would set the text of the entry named `someTexture` in the pack with the id `examplePack`. Categories work the same way as they do in .rpo files and everywhere else: you use `categoryName.entryName` instead of `entryName`.
## Adding a tooltip to an entry
The translation system also enables you to add tooltips (small pieces of text that are shown only if the users' mouse cursor is above the option) to config options. The syntax for these is as follows: `rpo.tooltip.<PackID>.<Entry Name>`.\
The translation system also enables you to add tooltips (small pieces of text that are shown only if the users' mouse cursor is above the option) to config options. The syntax for these is as follows: `rpo.tooltip.<PackID>.<Entry Name>`.
Example:
```json
{

View File

@ -1,5 +1,5 @@
# Old wiki
The pages here are for reference and may include information not present in the updated wiki.\
The pages here are for reference and may include information not present in the updated wiki.
However, the quality of the documentation here is worse.
## Migration status

View File

@ -1,5 +1,6 @@
You can use the `expansions` block in your .rpo to replace content with a value computed through executing a custom [starscript](https://github.com/MeteorDevelopment/starscript/wiki).\
All values are available in starscript like this: `<pack id>.<entry>`\
You can use the `expansions` block in your .rpo to replace content with a value computed through executing a custom [starscript](https://github.com/MeteorDevelopment/starscript/wiki).
All values are available in starscript like this: `<pack id>.<entry>`
## Example:
en_us.json.rpo:
```