Skip to content

Commit 32c879e

Browse files
committed
More Config
1 parent 15509d9 commit 32c879e

5 files changed

Lines changed: 85 additions & 9 deletions

File tree

docs/.vitepress/config.mts

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,9 @@ export default defineConfig({
2626
collapsed: false,
2727
items: [
2828
{ text: 'What is Sky Aesthetics', link: '/introduction/what-is-it' },
29-
{ text: 'Getting Started', link: '/introduction/getting-started' }
29+
{ text: 'Getting Started', link: '/introduction/getting-started' },
30+
{ text: 'Compatibility', link: '/introduction/compatibility' }
31+
3032
]
3133
},
3234
{
@@ -45,7 +47,8 @@ export default defineConfig({
4547
{ text: 'Cloud Settings', link: '/sky/settings/clouds' },
4648
{ text: 'Stars Settings', link: '/sky/settings/stars' },
4749
{ text: 'Skybox Settings', link: '/sky/settings/skybox' },
48-
{ text: 'Fog Settings', link: '/sky/settings/fog' }
50+
{ text: 'Render Condition ', link: '/sky/settings/condition' },
51+
{ text: 'Light Settings', link: '/sky/settings/light' }
4952
]
5053
}
5154
]

docs/introduction/compatibility.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Compatibility
2+
3+
Sky Aesthetics drastically change how the world is rendered when a sky is loaded.
4+
That's why some mod can be incompatible with Sky Aesthetics.
5+
6+
Here a list of known incompatibility/compatibility.
7+
8+
| Mod | Problems | Status |
9+
|-----------------|:----------------------------:|-----------------------------------------:|
10+
| Lunar | Custom moons weren't showing | <Badge type="tip" text="Fixed" /> |
11+
| Astrocraft | Custom Sky wasn"t showing | <Badge type="tip" text="Fixed" /> |
12+
| Distant Horizon | DH override cloud rendering | <Badge type="tip" text="Fixed" /> |
13+
| Iris/Shader | A lot of problems happen | <Badge type="danger" text="Not Fixed" /> |
14+
15+
::: tip
16+
Most of the time, the problem is only a part of Sky Aesthetics (Ex: multiple clouds, etc...).
17+
18+
You can check Sky Aesthetics config file to disable certain part of the rendering
19+
:::

docs/introduction/getting-started.md

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,15 @@ Here are some terms you will often see in the documentation:
2020
- **Sky Object**: An object that can be added to the sky (like moons, planets, etc.)
2121
- **Skybox**: A image that cover all the minecraft sky.
2222

23-
### File Structure
23+
### Creation Options
24+
You can create your sky configuration file by hand or use the sky creation screen.
25+
This screen is available in-game by pressing the button in the pause menu.
26+
27+
::: warning
28+
The sky creation screen is only available when [OwO Lib](https://modrinth.com/mod/owo-lib) is installed.
29+
:::
30+
31+
### Creating Your First Sky
2432
This is a basic structure of a resource pack using Sky Aesthetics.:
2533
::: warning
2634
Here [namespace] should be replaced by your resource pack namespace. If my datapack is named `my_cool_pack`, the path to my sky configuration file will be `assets/my_cool_pack/sky_aesthetics/your_sky.json`.
@@ -35,10 +43,8 @@ Here [namespace] should be replaced by your resource pack namespace. If my datap
3543
└─ pack.mcmeta
3644
```
3745

38-
### Creation Options
39-
You can create your sky configuration file by hand or use the sky creation screen.
40-
This screen is available in-game by pressing the button in the pause menu.
46+
All the work you will do is in the `your_sky.json`.
47+
If you use custom textures, the resourcelocation (the "path") for theses will be `[namespace]:textures/my_texture.png`
48+
49+
Now, all you need to do is to fill the file with the [**required**](/sky) values and then add the wanted settings.
4150

42-
::: warning
43-
The sky creation screen is only available when [OwO Lib](https://modrinth.com/mod/owo-lib) is installed.
44-
:::

docs/sky/settings/condition.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# Render Condition Settings
2+
3+
This Setting allow you to configure when your sky will be visible.
4+
5+
This Setting as two variant
6+
```json
7+
{
8+
//other sky settings ...
9+
"condition": {
10+
"biomes": "#minecraft:is_cold"
11+
}
12+
}
13+
```
14+
15+
or
16+
17+
```json
18+
{
19+
//other sky settings ...
20+
"condition": {
21+
"biome": "minecraft:badland"
22+
}
23+
}
24+
25+
```
26+
27+
## Fields
28+
- `biome`: A Resourcekey for a biome.
29+
- `biomes`: A biome tag
30+

docs/sky/settings/light.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Light Settings <Badge type="warning" text="beta" />
2+
3+
This Setting allow you to configure how light works in the dimension when the sky is on.
4+
5+
```json
6+
{
7+
//other sky settings ...
8+
"light_settings": {
9+
"forceBrightLightmap": true,
10+
"constantAmbientLight": false
11+
}
12+
}
13+
```
14+
15+
## Fields
16+
- `forceBrightLightmap`: A Boolean value that define if the Brigh Lightmap should be used (Idk why you would you use it).
17+
- `constantAmbientLight`: A Boolean value that define if the world should have a constant ambient light (like in the end)
18+

0 commit comments

Comments
 (0)