Skip to content

Commit 5303c0d

Browse files
committed
docs(config): Add docs pertaining to config opts
1 parent db5837d commit 5303c0d

File tree

1 file changed

+14
-1
lines changed

1 file changed

+14
-1
lines changed

README.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,20 @@ A very basic, yet still robust and extendable, loading screen.
3131

3232
*Note: This resource uses the `MANUAL_SHUTDOWN` feature. You can learn more about that [here]()*
3333

34-
### Customize
34+
## Config Options
35+
36+
The config can be found in `web/config.js`. This holds a plethora of configuration options.
37+
38+
| Option | Description | Example
39+
| --- | --- | --- |
40+
| LOADSCREEN_TIPS | An array of `TipObjects` for displaying in the loading screen | [Here](https://github.com/project-error/pe-basicloading/blob/db5837df618a9d9fd6a4cd2a218bb91e81a359b7/web/config.js#L7)|
41+
| TIP_CHANGE_INTERVAL | The interval (ms) at which Tips change automatically | `TIP_CHANGE_INTERVAL = 12000` |
42+
| BACKGROUND_CHANGE_INTERVAL | The interval (ms) at which backgrounds automatically switch | `BACKGROUND_CHANGE_INTERVAL = 15000` |
43+
| BACKGROUND_IMAGES | An array of file names for images present in the `web/backgrounds` folder. | `BACKGROUND_IMAGES = ["1.jpg","2.jpg"]`
44+
| ENABLE_CURSOR | Whether to enable the cursor while in the loading screen | `ENABLE_CURSOR = false`
45+
| ENABLE_GFM_MARKDOWN | Whether to enable the `Github Flavored Markdown` spec for the parser | `ENABLE_GFM_MARKDOWN = true`
46+
47+
## Customize
3548

3649
### Adding Backgrounds
3750

0 commit comments

Comments
 (0)