Skip to content

Commit ddf31f5

Browse files
Stampede2011Stampede2011
committed
feat: added the initial skiescrates documentation
1 parent 61c9645 commit ddf31f5

47 files changed

Lines changed: 3294 additions & 5 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎astro.config.mjs‎

Lines changed: 121 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,127 @@ export default defineConfig({
4444
]
4545
}
4646
],
47+
},
48+
{
49+
label: 'SkiesCrates',
50+
link: '/skiescrates/getting_started/introduction',
51+
icon: 'seti:folder',
52+
items: [
53+
{
54+
label: "Getting Started",
55+
items: [
56+
'skiescrates/getting_started/introduction',
57+
'skiescrates/getting_started/installation',
58+
'skiescrates/getting_started/commands_permissions',
59+
'skiescrates/getting_started/economies',
60+
'skiescrates/getting_started/placeholders',
61+
'skiescrates/getting_started/gui_types',
62+
'skiescrates/getting_started/faqs'
63+
]
64+
},
65+
{
66+
label: "Main Config",
67+
items: [
68+
'skiescrates/config/config',
69+
'skiescrates/config/keys_options',
70+
'skiescrates/config/storage_options',
71+
'skiescrates/config/migration_options',
72+
'skiescrates/config/webhook_options',
73+
]
74+
},
75+
{
76+
label: "Crates",
77+
items: [
78+
'skiescrates/crates/crates',
79+
'skiescrates/crates/cost_options',
80+
'skiescrates/crates/failure_options',
81+
'skiescrates/crates/block_options',
82+
'skiescrates/crates/hologram_options',
83+
'skiescrates/crates/examples'
84+
]
85+
},
86+
{
87+
label: "Rewards",
88+
items: [
89+
'skiescrates/rewards/rewards',
90+
'skiescrates/rewards/limit_options',
91+
{
92+
label: "Types",
93+
items: [
94+
'skiescrates/rewards/types/command_console',
95+
'skiescrates/rewards/types/command_player',
96+
'skiescrates/rewards/types/item',
97+
'skiescrates/rewards/types/pokemon',
98+
]
99+
}
100+
]
101+
},
102+
{
103+
label: "Keys",
104+
items: [
105+
'skiescrates/keys/keys',
106+
'skiescrates/keys/keys_menu',
107+
]
108+
},
109+
{
110+
label: "Previews",
111+
items: [
112+
'skiescrates/previews/previews',
113+
'skiescrates/previews/preview_settings',
114+
'skiescrates/previews/preview_buttons'
115+
]
116+
},
117+
{
118+
label: "Opening Animations",
119+
items: [
120+
'skiescrates/openings/opening_animations',
121+
{
122+
label: "Inventory",
123+
items: [
124+
'skiescrates/openings/inventory/inventory_opening',
125+
'skiescrates/openings/inventory/animation_settings',
126+
'skiescrates/openings/inventory/spinning_items',
127+
'skiescrates/openings/inventory/presets'
128+
]
129+
},
130+
{
131+
label: "World",
132+
items: [
133+
'skiescrates/openings/world/world_opening',
134+
{
135+
label: "Types",
136+
items: [
137+
'skiescrates/openings/world/types/simple_roll',
138+
]
139+
}
140+
]
141+
}
142+
]
143+
},
144+
{
145+
label: "Particles",
146+
items: [
147+
'skiescrates/particles/particle_animations',
148+
'skiescrates/particles/particle_effects',
149+
{
150+
label: "Types",
151+
items: [
152+
'skiescrates/particles/types/circle',
153+
'skiescrates/particles/types/spiral',
154+
'skiescrates/particles/types/pulse',
155+
'skiescrates/particles/types/beam'
156+
]
157+
}
158+
]
159+
},
160+
{
161+
label: "Items",
162+
items: [
163+
'skiescrates/items/item_options',
164+
'skiescrates/items/components',
165+
]
166+
}
167+
],
47168
}
48169
]),
49170
],

‎src/content/docs/index.mdx‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,11 @@ import { Card, CardGrid } from '@astrojs/starlight/components';
2626

2727
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>
29+
<Card title="SkiesCrates" icon="seti:folder">
30+
Server-sided customizable Crates with rewards for Fabric servers
31+
32+
Coming soon for free on Modrinth. Documentation available [here](/skiescrates/getting_started/introduction/)
33+
</Card>
2934
<Card title="SkiesKits" icon="add-document">
3035
Coming soon!
3136
</Card>
@@ -41,9 +46,6 @@ import { Card, CardGrid } from '@astrojs/starlight/components';
4146
<Card title="CobblemonPlaceholders" icon="open-book">
4247
Coming soon!
4348
</Card>
44-
<Card title="SkiesCrates" icon="open-book">
45-
Coming soon!
46-
</Card>
4749
<Card title="Redeemed" icon="open-book">
4850
Coming soon!
4951
</Card>

‎src/content/docs/skiescrates/config/config.mdx‎

Lines changed: 109 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,109 @@
1+
---
2+
title: Mod Configuration
3+
description: Guide to configure the Main Config for the SkiesCrates mod
4+
---
5+
6+
import { FileTree } from '@astrojs/starlight/components';
7+
import { Code } from '@astrojs/starlight/components';
8+
import { Badge } from '@astrojs/starlight/components';
9+
import { LinkCard } from '@astrojs/starlight/components';
10+
import defaultConfig from './default_config.json?raw';
11+
12+
The guide explains configuring the main `config.json` file for SkiesCrates. The main configuration file contains global settings that affect the entire mod.
13+
14+
<FileTree>
15+
- config
16+
- skiescrates
17+
- config.json
18+
</FileTree>
19+
20+
***
21+
## Example File
22+
<Code code={defaultConfig} lang="json" title="config.json" />
23+
24+
## Options
25+
### Debug
26+
Toggles the debugging status to make finding mistakes easier. Actual errors with the mod will still be displayed even if false. This is not recommended to leave enabled as it will display a lot of information. Can also be toggled using the command `/guis debug`.
27+
```json
28+
"debug": false
29+
```
30+
### Interaction Limiter
31+
Set the interaction limit rate in milliseconds, which prevents players from spamming interactions with crates. Recommended to not set too low as frequent interactions may lead to lag.
32+
```json
33+
"interaction_limiter": 1000
34+
```
35+
### Key Options
36+
Settings for the keys menu and command.
37+
```json
38+
"keys": {
39+
"aliases" [
40+
"keys"
41+
],
42+
"use_menu": true
43+
}
44+
```
45+
<LinkCard
46+
title="Keys Options"
47+
href="/skiescrates/config/keys_options/"
48+
description="Options for the Keys menu and command"
49+
/>
50+
51+
### Storage Options
52+
Settings for data storage.
53+
```json
54+
"storage": {
55+
"type": "SQLITE",
56+
"host": "localhost",
57+
"port": 27017,
58+
"database": "skiescrates",
59+
"username": "root",
60+
"password": "",
61+
"table_prefix": "skiescrates_",
62+
"properties": {
63+
"useUnicode": "true",
64+
"characterEncoding": "utf8"
65+
},
66+
"pool_settings": {
67+
"maximum_pool_size": 10,
68+
"minimum_idle": 10,
69+
"keepalive_time": 0,
70+
"connection_timeout": 30000,
71+
"idle_timeout": 600000,
72+
"max_lifetime": 1800000
73+
},
74+
"url_override": ""
75+
}
76+
```
77+
<LinkCard
78+
title="Storage Options"
79+
href="/skiescrates/config/storage_options/"
80+
description="Options for data storage"
81+
/>
82+
83+
### Migration Options
84+
Settings for data migration!
85+
```json
86+
"migration": {
87+
"keys": []
88+
}
89+
```
90+
<LinkCard
91+
title="Migration Options"
92+
href="/skiescrates/config/migration_options/"
93+
description="Options for migration"
94+
/>
95+
96+
### Webhook Options
97+
Settings for sending Discord webhooks on certain events.
98+
```json
99+
"webhooks": {
100+
"duplicate_key": {
101+
"url": ""
102+
}
103+
}
104+
```
105+
<LinkCard
106+
title="Webhook Options"
107+
href="/skiescrates/config/webhook_options/"
108+
description="Options for Discord webhooks"
109+
/>

‎src/content/docs/skiescrates/config/default_config.json‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
{
2+
"debug": true,
3+
"interaction_limiter": 1000,
4+
"keys": {
5+
"aliases": [
6+
"keys"
7+
],
8+
"use_menu": true
9+
},
10+
"storage": {
11+
"type": "SQLITE",
12+
"host": "localhost",
13+
"port": 27017,
14+
"database": "skiescrates",
15+
"username": "root",
16+
"password": "",
17+
"table_prefix": "skiescrates_",
18+
"properties": {
19+
"useUnicode": "true",
20+
"characterEncoding": "utf8"
21+
},
22+
"pool_settings": {
23+
"maximum_pool_size": 10,
24+
"minimum_idle": 10,
25+
"keepalive_time": 0,
26+
"connection_timeout": 30000,
27+
"idle_timeout": 600000,
28+
"max_lifetime": 1800000
29+
},
30+
"url_override": ""
31+
},
32+
"migration": {
33+
"keys": []
34+
},
35+
"webhook": {
36+
"duplicate_key": {
37+
"url": ""
38+
}
39+
}
40+
}

‎src/content/docs/skiescrates/config/keys_options.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
title: Keys Options
3+
description: Configuration options for the Keys menu and command in SkiesCrates
4+
---
5+
6+
Settings for the keys menu and command.
7+
```json
8+
"keys": {
9+
"aliases" [
10+
"keys"
11+
],
12+
"use_menu": true
13+
}
14+
```
15+
## Aliases
16+
A list of commands that can be used to access the keys menu. Each entry is a new command, which should only be one word and unused by another mod. **A restart is required to register commands**!
17+
```json
18+
"aliases": [
19+
"keys"
20+
]
21+
```
22+
## Use Menu
23+
Toggles whether the keys menu GUI (`config/skiescrates/menus/keys.json`) should be used when accessing keys. If false, the list of keys will be printed in chat.
24+
```json
25+
"use_menu": true
26+
```

‎src/content/docs/skiescrates/config/migration_options.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
title: Migrations Options
3+
description: Configuration options for migration in SkiesCrates
4+
---
5+
6+
Settings for data migration!
7+
```json
8+
"migration": {
9+
"keys": []
10+
}
11+
```
12+
## Key Migration
13+
Used to allow items from other Crate mods to act as keys. Provide a key IDs and it's related NBT key->value pair. The example below shows a migration for a key containing the NBT `"CrateName:old_key_id"` being allowed to act as a `example_key` in SkiesCrates.
14+
```json
15+
"keys": [
16+
{
17+
"key": "example_key",
18+
"nbt": {
19+
"key": "CrateName",
20+
"value": "old_key_id"
21+
}
22+
}
23+
]
24+
```

0 commit comments

Comments
 (0)