Skip to content

Commit 6d65cbf

Browse files
committed
feat: updated minor formatting and organization of skiesguis docs
1 parent 7989a8e commit 6d65cbf

15 files changed

Lines changed: 344 additions & 62 deletions

astro.config.mjs

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ export default defineConfig({
99
starlight({
1010
title: 'SkiesDev Docs',
1111
social: [
12-
{ icon: 'github', label: 'GitHub', href: 'https://github.com/pokeskies' },
12+
{ icon: 'github', label: 'GitHub', href: 'https://github.com/pokeskies/docs' },
1313
{ icon: 'discord', label: 'Discord', href: 'https://discord.gg/cgBww275Fg' },
1414
{ icon: 'heart', label: 'Ko-Fi', href: 'https://ko-fi.com/stampede2011' }
1515
],
@@ -26,21 +26,21 @@ export default defineConfig({
2626
'skiesguis/getting_started/introduction',
2727
'skiesguis/getting_started/installation',
2828
'skiesguis/getting_started/commands_permissions',
29-
'skiesguis/getting_started/main_config',
3029
'skiesguis/getting_started/economies',
3130
'skiesguis/getting_started/placeholders',
3231
'skiesguis/getting_started/faqs'
3332
]
3433
},
34+
"skiesguis/main_config",
3535
{
36-
label: "GUI Configuration",
36+
label: "GUIs",
3737
items: [
38-
'skiesguis/gui_config/base',
39-
'skiesguis/gui_config/items',
40-
'skiesguis/gui_config/actions',
41-
'skiesguis/gui_config/requirements',
42-
'skiesguis/gui_config/examples',
43-
'skiesguis/gui_config/components'
38+
'skiesguis/guis/base',
39+
'skiesguis/guis/items',
40+
'skiesguis/guis/actions',
41+
'skiesguis/guis/requirements',
42+
'skiesguis/guis/components',
43+
'skiesguis/guis/examples'
4444
]
4545
}
4646
],

src/content/docs/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ import { Card, CardGrid } from '@astrojs/starlight/components';
2424
<Card title="SkiesGUIs" icon="pencil">
2525
Server-sided custom GUIs for Fabric servers
2626

27-
Available for free on [Modrinth](https://modrinth.com/project/skiesguis/). Documentation available [here](/skiesguis/getting_started/introduction/)
27+
Available for free on <a href="https://modrinth.com/project/skiesguis/" target="_blank" rel="noopener noreferrer">Modrinth</a>. Documentation available [here](/skiesguis/getting_started/introduction/)
2828
</Card>
2929
<Card title="SkiesKits" icon="add-document">
3030
Coming soon!
Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"debug": false
3+
}

src/content/docs/skiesguis/getting_started/economies.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,20 +3,20 @@ title: Supported Economies
33
description: Supported Economy mods for the SkiesGUIs mod
44
---
55

6-
When using actions/requirements that are relating to currencies, you can specify both the economy mod to use and the currency to use (if the mod supports it). The mod will still load even if an integration is not found, but Currency related Requirements and Actions will not function.
6+
When using actions/requirements that are relating to currencies, you can specify both the economy mod to use and the currency to use (if the mod supports it). The mod will still load even if an integration is not found, but Currency related functions may not work.
77

88
## Supported Types
99
The following are the different types of Economy Integrations supported.
1010
| Identifier | Mod |
1111
|---------------|---------------------------------------------------------|
12-
| IMPACTOR | [Impactor](https://modrinth.com/mod/impactor) |
12+
| IMPACTOR | <a href="https://modrinth.com/mod/impactor" target="_blank" rel="noopener noreferrer">Impactor</a> |
1313
| PEBBLES | Pebbles Economy |
14-
| COBBLEDOLLARS | [CobbleDollars](https://modrinth.com/mod/cobbledollars) |
15-
| BECONOMY | [BEconomy](https://modrinth.com/mod/beconomy) |
14+
| COBBLEDOLLARS | <a href="https://modrinth.com/mod/cobbledollars" target="_blank" rel="noopener noreferrer">CobbleDollars</a> |
15+
| BECONOMY | <a href="https://modrinth.com/mod/beconomy" target="_blank" rel="noopener noreferrer">BEconomy</a> |
1616

1717
## Example Use
1818
When specifying an economy type in an action or requirement, use the following format:
19-
>```json
20-
> "economy": "IMPACTOR",
21-
> "currency": "impactor:dollars"
22-
>```
19+
```json
20+
"economy": "IMPACTOR",
21+
"currency": "impactor:dollars" // Optional, default currency will be used if not specified
22+
```

src/content/docs/skiesguis/getting_started/faqs.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@ Due to the potential complexity of this mod, there are some frequent issues and
1414
**Q:** How can I add custom GUI textures to my GUIs?
1515

1616
**A:** This can be done a few ways, but the most common method is to use a Resource Pack that overrides an unused font character with a custom texture. You then can use that overriden font character in the title of the GUI. You may need to adjust the horizontal and vertical alignment using a Negative Space Font Character and the fon character's vertical offset.
17-
There are several guides on this process, such as [this one](https://www.youtube.com/watch?v=vgyjZjOl0tY).
17+
There are several guides on this process, such as <a href="https://www.youtube.com/watch?v=vgyjZjOl0tY" target="_blank" rel="noopener noreferrer">this one</a>.
1818

1919
***
2020

21-
Got questions that aren't answered here? Feel free to reach out on the [Discord](https://discord.gg/cgBww275Fg)!
21+
Got questions that aren't answered here? Feel free to reach out on the <a href="https://discord.gg/cgBww275Fg" target="_blank" rel="noopener noreferrer">Discord</a>!

src/content/docs/skiesguis/getting_started/installation.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ SkiesGUIs requires the following to run (as of January 2026):
2020

2121
## Installation Steps
2222
1. Set up a Fabric server with Minecraft 1.21.1
23-
2. Install the SkiesGUIs mod jar into the `mods` folder of your server. Download the mod [here](https://modrinth.com/mod/skiesguis)!
23+
2. Install the SkiesGUIs mod jar into the `mods` folder of your server. Download the mod <a href="https://modrinth.com/mod/skiesguis" target="_blank" rel="noopener noreferrer">here</a>!
2424
3. Download all required dependencies for the mod (See [Server Requirements](#server-requirements) above)]
2525
4. Restart the server to generate the configuration files and folders.
2626
5. Open the example GUI using the command `/gui open example_gui` while in-game.
@@ -29,17 +29,17 @@ SkiesGUIs requires the following to run (as of January 2026):
2929
## Optional Integrations
3030
SkiesGUIs supports a variety of optional integrations to enhance functionality. These integrations are not required but can provide added features.
3131
- **Economy Plugins** - SkiesGUIs supports a variety of economy plugins for use
32-
- Impactor
33-
- BEconomy
34-
- CobbleDollars
32+
- <a href="https://modrinth.com/mod/impactor" target="_blank" rel="noopener noreferrer">Impactor</a>
33+
- <a href="https://modrinth.com/mod/beconomy" target="_blank" rel="noopener noreferrer">BEconomy</a>
34+
- <a href="https://modrinth.com/mod/cobbledollars" target="_blank" rel="noopener noreferrer">CobbleDollars</a>
3535
- Pebbles Economy
3636
- **See the [Supported Economies](/skiesguis/getting_started/economies/) page for more information.**
3737
- **Placeholder Services** - SkiesGUIs supports a variety of Placeholder APIs for use with placeholders in GUI configurations.
38-
- MiniPlaceholders
39-
- TextPlaceholderAPI (not the spigot one)
38+
- <a href="https://modrinth.com/plugin/miniplaceholders" target="_blank" rel="noopener noreferrer">MiniPlaceholders</a>
39+
- <a href="https://modrinth.com/mod/placeholder-api" target="_blank" rel="noopener noreferrer">TextPlaceholderAPI</a> (not the spigot one)
4040
- **See the [Placeholders](/skiesguis/getting_started/placeholders/) page for more information.**
4141
- **Additional Actions** - SkiesGUIs supports additional action types through optional dependencies.
42-
- Cobblemon - `MOLANG`
42+
- <a href="https://modrinth.com/mod/cobblemon" target="_blank" rel="noopener noreferrer">Cobblemon</a> - `MOLANG`
4343
- **Additional Requirements** - SkiesGUIs supports additional requirement types through optional dependencies.
44-
- Plan - `PLAN_PLAYTIME`
45-
- Cobblemon - `MOLANG`
44+
- <a href="https://www.spigotmc.org/resources/plan-player-analytics.32536/" target="_blank" rel="noopener noreferrer">Plan</a> (fabric version) - `PLAN_PLAYTIME`
45+
- <a href="https://modrinth.com/mod/cobblemon" target="_blank" rel="noopener noreferrer">Cobblemon</a> - `MOLANG`

src/content/docs/skiesguis/getting_started/introduction.md

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ Welcome to the documentation for the SkiesGUIs mod! This guide will help you get
77
***
88

99
## Quick Start
10-
1. Install the SkiesGUIs mod jar onto your server. Download the mod [here](https://modrinth.com/mod/skiesguis)!
10+
1. Install the SkiesGUIs mod jar onto your server. Download the mod <a href="https://modrinth.com/mod/skiesguis" target="_blank" rel="noopener noreferrer">here</a>!
1111
2. Open GUIs using the command `/gui open <id>` while in-game.
1212
3. Modify and create new GUIs in the `config/skiesguis/guis/` folder.
1313

@@ -32,27 +32,30 @@ The mod supports a variety of features, including:
3232
<br>Initial introduction to the SkiesGUIs mod, understanding the purpose and features of the mod.
3333
2. [Installation](/skiesguis/getting_started/installation/)
3434
<br>Guide to install the SkiesGUIs mod, dependencies, and optional integrations.
35-
3. [Main Config](/skiesguis/getting_started/main_config/)
36-
<br>Guide to configure the main `config.json` file for SkiesGUIs. These features apply globally to the mod.
3735
4. [Commands and Permissions](/skiesguis/getting_started/commands_permissions/)
3836
<br>List of commands and permissions available in the SkiesGUIs mod.
3937
5. [Supported Economies](/skiesguis/getting_started/economies/)
4038
<br>List of supported economy plugins for use with SkiesGUIs.
4139
6. [Placeholders](/skiesguis/getting_started/placeholders/)
4240
<br>List of supported Placeholder APIs and available placeholders for use with SkiesGUIs.
43-
7. [FAQs](/skiesguis/getting_started/faqs/)
41+
8. [FAQs](/skiesguis/getting_started/faqs/)
4442
<br>Frequently Asked Questions about the SkiesGUIs mod, including troubleshooting tips and common implementation questions.
4543

46-
### GUI Configuration
47-
1. [Base Configuration](/skiesguis/gui_config/base/)
44+
### Configuration
45+
#### Base Config
46+
1. [Main Configuration](/skiesguis/main_config/)
47+
<br>Guide to configure the main `config.json` file for SkiesGUIs. These features apply globally to the mod.
48+
49+
#### GUI Configuration
50+
1. [Base Configuration](/skiesguis/guis/base/)
4851
<br>Guide to understanding the very basics of a GUI configuration file.
49-
2. [Items](/skiesguis/gui_config/items/)
52+
2. [Items](/skiesguis/guis/items/)
5053
<br>Configuration of items within a GUI, including display properties, behaviors, and advanced options.
51-
3. [Actions](/skiesguis/gui_config/actions/)
54+
3. [Actions](/skiesguis/guis/actions/)
5255
<br>Configuration of actions that can be executed within a GUI, including additional advanced options.
53-
4. [Requirements](/skiesguis/gui_config/requirements/)
56+
4. [Requirements](/skiesguis/guis/requirements/)
5457
<br>Configuration of requirements that can be used to restrict viewing items, click actions, and GUI access.
55-
5. [Components](/skiesguis/gui_config/components/)
56-
<br>Guide to using Components and specifically how to make use of them in the SkiesGUIs mod.
57-
6. [Examples](/skiesguis/gui_config/examples/)
58+
5. [Components](/skiesguis/guis/components/)
59+
<br>Guide to using Components and specifically how to make use of them in the SkiesGUIs mod.
60+
6. [Examples](/skiesguis/guis/examples/)
5861
<br>Example GUI configurations for SkiesGUIs to help get started.

src/content/docs/skiesguis/getting_started/placeholders.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,9 @@ SkiesGUIs supports the use of Placeholder APIs to allow for dynamic text within
77

88
## Supported Mods
99
The following are the different types of Placeholders Services are supported.
10-
- [MiniPlaceholders](https://modrinth.com/plugin/miniplaceholders)
11-
- [TextPlaceholderAPI](https://modrinth.com/mod/placeholder-api)
12-
- [Impactor](https://modrinth.com/mod/impactor)
10+
- <a href="https://modrinth.com/plugin/miniplaceholders" target="_blank" rel="noopener noreferrer">MiniPlaceholders</a>
11+
- <a href="https://modrinth.com/mod/placeholder-api" target="_blank" rel="noopener noreferrer">TextPlaceholderAPI</a>
12+
- <a href="https://modrinth.com/mod/impactor" target="_blank" rel="noopener noreferrer">Impactor</a>
1313

1414
## Default Placeholders
1515
By default, the mod comes with a few built-in placeholders that can be used without any additional Placeholder API mods installed. These include:

src/content/docs/skiesguis/gui_config/actions.md renamed to src/content/docs/skiesguis/guis/actions.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,12 @@ Generally, actions follow the below format. A MAP of actions that may be ran. Ea
2323

2424
## Action Options
2525
### Type (required)
26-
The type of action that this entry is. Must be in full capitalization. A list of types can be found in [Action Types](#action-types).
26+
The type of action that this entry is. A list of types can be found in [Action Types](#action-types).
2727
```json
2828
"type": "MESSAGE"
2929
```
3030
### Click
31-
The type of click that is required for this action to execute. Must be in full capitalization. A list of types can be found in [Click Types](#click-types). Defaults to ANY if not provided.
31+
The type of click that is required for this action to execute. A list of types can be found in [Click Types](#click-types). Defaults to ANY if not provided.
3232
```json
3333
"click": "ANY"
3434
```
@@ -56,7 +56,7 @@ Additional options are available depending on the type of action used. See [Acti
5656
***
5757

5858
## Action Types
59-
These are the available Action Types and their respective settings. Some settings are optional, while others may be required.
59+
These are the available Action Types along with a short description and the required mods, if any.
6060

6161
| Identifier | Description | Required Mods |
6262
|-------------------|---------------------------------------------------------------------------------------|---------------|
@@ -77,7 +77,7 @@ These are the available Action Types and their respective settings. Some setting
7777
| MOLANG | Executes a set of molang scripts/expressions | Cobblemon |
7878

7979
### Message Action
80-
Sends a message to the player, parsed by Placeholder Services. Uses [MiniMessage formatting](https://docs.advntr.dev/minimessage/format.html)!
80+
Sends a message to the player, parsed by Placeholder Services. Uses <a href="https://docs.advntr.dev/minimessage/format.html" target="_blank" rel="noopener noreferrer">MiniMessage formatting</a>!
8181
```json
8282
"type": "MESSAGE",
8383
"message": ["<blue>This is a message to the player!"]
@@ -96,7 +96,7 @@ Runs a command as the player, parsed by Placeholder Services.
9696
"permission_level": 1 // Optional. Permission level the command is ran as
9797
```
9898
### Broadcast Action
99-
Broadcasts a message to all players, parsed by Placeholder Services. Uses [MiniMessage formatting](https://docs.advntr.dev/minimessage/format.html)!
99+
Broadcasts a message to all players, parsed by Placeholder Services. Uses <a href="https://docs.advntr.dev/minimessage/format.html" target="_blank" rel="noopener noreferrer">MiniMessage formatting</a>!
100100
```json
101101
"type": "BROADCAST",
102102
"message": ["<green>%player% has clicked the special item!"]

src/content/docs/skiesguis/gui_config/base.mdx renamed to src/content/docs/skiesguis/guis/base.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Every GUI can have a base set of configuration options defined. Most importantly
2929
```
3030

3131
### Title (required)
32-
The message displayed at the top of the GUI. Uses [MiniMessage formatting](https://docs.advntr.dev/minimessage/format.html)!
32+
The message displayed at the top of the GUI. Uses <a href="https://docs.advntr.dev/minimessage/format.html" target="_blank" rel="noopener noreferrer">MiniMessage formatting</a>!
3333
```json
3434
"title": "<dark_gray>Example Title"
3535
```

0 commit comments

Comments
 (0)