Slightly adapt docs for mkdocs

This commit is contained in:
JFronny 2021-09-15 15:17:32 +02:00
parent 4eeba10343
commit ca1c113bab
No known key found for this signature in database
GPG Key ID: BEC5ACBBD4EE17E5
9 changed files with 45 additions and 18 deletions

View File

@ -1,4 +1,4 @@
# Canvas/FREX integration
# Usage in canvas/frex shaders
## Background
The FREX shader API (which shaders targeting the Canvas renderer utilize) allows other mods to register config code which shaders may `#include`.
Respackopts is one of such mods and utilizes this feature to expose the packs respackopts config.
@ -8,7 +8,7 @@ All you need to do to access respackotps values is paste the following in a file
However, usually you will want to still have a pack that works if respackotps is not present. In that case, canvas will still load the file,
however, values that respackotps registers will not be available leading to compile errors.
To avoid this, I recommend creating a source file in your own shader which will load default values if respackotps isn't present. You can do that as follows:
```
```glsl
#include respackopts:config_supplier
#ifdef respackopts_loaded

View File

@ -1,4 +1,4 @@
# ResourcePackOpts Config.
# Creating a Screen
### 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).

View File

@ -1,4 +1,4 @@
# ResPackOpts Multi File Toggle (Multi Selection)
# Select one of multiple files
This Allows you to pick between multiple files (3 or more files) using similar logic to [Toggle Files](./ToggleFiles.md)
But this requires multiple `.rpo` files to achieve the desired goal.

View File

@ -1,9 +1,9 @@
# ResPackOpts Home
# About
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
- Frex/Canvas Shaders
- Canvas/Frex Shaders
- Resource Packs
- DataPacks

View File

@ -1,4 +1,4 @@
# ResPackOpts Toggle Files (Boolean-based logic)
# Toggle Files
This is a simple `IF` statement simply returning true/false to if the texture/file should be loaded into the pack.
(Turns the texture "on" or "off").
@ -27,4 +27,4 @@ You will need to navigate to the file you would like to toggle inside your resou
}
```
### See [Toggle Files With Fallback](./ToggleFilesWithFallback.md) to see how to swap textures out with each other (alternate Options)
See [Switch between two files](./ToggleFilesWithFallback.md) to see how to swap textures out with each other (alternate Options)

View File

@ -1,4 +1,4 @@
# ResPackOpts Toggle Files With A Fallback Option (Alternate Files)
# Switch between two files
This is a simple `IF` statement simply returning true/false to if the texture/file should be loaded into the pack.
(Pick one file over another).
You will need the `Pack ID` and `Entry Name` from your `/assets/respackopts/conf.json` that you created earlier
@ -28,4 +28,4 @@ You will need to navigate to the file you would like to toggle inside your resou
}
```
### See [Toggle Files ](./ToggleFiles.md) to see how to just disable files.
See [Toggle Files ](./ToggleFiles.md) to see how to just disable files.

View File

@ -5,10 +5,10 @@ However, the quality of the documentation here is worse.
## Migration status
| Page | Status |
| --- | --- |
| home | done |
| adding_entries | done |
| canvas | done |
| conditional | TODO explain advanced conditions/condition arrays |
| expand | TODO |
| fallbacks | TODO: explain multiple fallbacks for files |
| how_it_works | deliberately left out |
| [home](home.md) | done |
| [adding_entries](adding_entries.md) | done |
| [canvas](canvas.md) | done |
| [conditional](conditional.md) | TODO explain advanced conditions/condition arrays |
| [expand](expand.md) | TODO |
| [fallbacks](fallbacks.md) | TODO: explain multiple fallbacks for files |
| [how_it_works](how_it_works.md) | deliberately left out |

View File

@ -1,3 +1,4 @@
# Resource expansion
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>`

View File

@ -1,4 +1,30 @@
site_name: respackopts docs
site_url: https://jfmods.gitlab.io/respackopts
theme: readthedocs
theme:
name: readthedocs
hljs_languages:
- glsl
site_dir: public
repo_url: https://gitlab.com/jfmods/respackopts
site_description: Documentation for the respackotps config engine for minecraft resource and data packs
site_author: JFronny
nav:
- 'README.md'
- 'Setting up':
- 'MainConfig.md'
- 'Translations.md'
- 'Select files':
- 'ToggleFiles.md'
- 'ToggleFilesWithFallback.md'
- 'MultipleFileSelection.md'
- 'Mod integrations':
- 'Canvas.md'
- 'Old wiki':
- About: 'old/README.md'
- home: 'old/home.md'
- adding_entries: 'old/adding_entries.md'
- canvas: 'old/canvas.md'
- conditional: 'old/conditional.md'
- expand: 'old/expand.md'
- fallbacks: 'old/fallbacks.md'
- how_it_works: 'old/how_it_works.md'