Skip to content

Commit

Permalink
added sky documention
Browse files Browse the repository at this point in the history
  • Loading branch information
TathanDev committed Aug 17, 2024
1 parent d000a0c commit c29e1ee
Show file tree
Hide file tree
Showing 4 changed files with 144 additions and 7 deletions.
12 changes: 6 additions & 6 deletions .vitepress/cache/deps/_metadata.json
Original file line number Diff line number Diff line change
@@ -1,25 +1,25 @@
{
"hash": "50b6c61b",
"configHash": "a9ea5b5a",
"hash": "ce0e9848",
"configHash": "68158654",
"lockfileHash": "36933d7d",
"browserHash": "ef49a2bb",
"browserHash": "7f69441f",
"optimized": {
"vue": {
"src": "../../../node_modules/vue/dist/vue.runtime.esm-bundler.js",
"file": "vue.js",
"fileHash": "899423f6",
"fileHash": "b577c921",
"needsInterop": false
},
"vitepress > @vue/devtools-api": {
"src": "../../../node_modules/@vue/devtools-api/dist/index.js",
"file": "vitepress___@vue_devtools-api.js",
"fileHash": "b99cc39a",
"fileHash": "aff71c8f",
"needsInterop": false
},
"vitepress > @vueuse/core": {
"src": "../../../node_modules/@vueuse/core/index.mjs",
"file": "vitepress___@vueuse_core.js",
"fileHash": "210c40fc",
"fileHash": "560d9668",
"needsInterop": false
}
},
Expand Down
4 changes: 3 additions & 1 deletion .vitepress/config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,9 @@ export default defineConfig({
text: 'Documentation',
items: [
{ text: 'The Planet file', link: '/custom-planets' },
{ text: 'The Screen files', link: '/custom-screen' }
{ text: 'The Screen files', link: '/custom-screen' },
{ text: 'Custom Sky', link: '/custom-sky' }

]
},
{
Expand Down
133 changes: 133 additions & 0 deletions custom-sky.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,133 @@
# Custom Planets Sky

Now that you have your beautiful planets registered, your planet need to have a beautiful sky !

## Creation of the Resourcepack

First, you'll need to create the base of the resourcepack. The structure of the resourcepack should look like this :

```
├─ assets
│ └─ [namespace]
│ └─ renderer
│ └─ sky
└─ pack.mcmeta
```

::: tip
`[namespace]` should be the same as your datapack
:::


**The sky folder**
This folder will contains all of the custom skies for our planets.

```json
{
"id": "minecraft:overworld",
"cloud": true,
"cloud_height": 192,
"fog": true,
"custom_vanilla_objects": {
"sun": true,
"sun_texture": "textures/environment/sun.png",
"sun_size": 30,
"moon": true,
"moon_phase": true,
"moon_texture": "textures/environment/moon_phases.png",
"moon_size": 20
},
"weather": [
{
"rain": true,
"acid_rain": false
}
],
"sunrise_color": 16755035,
"stars": {
"count": 30000,
"colored": true,
"all_days_visible": false
},
"sky_type": "NORMAL",
"sky_objects": []
}
```
`id`: The id of the dimension

`cloud`: if the dimension should have cloud

`cloud_height`: The height of the clouds

`fog`: if the dimension should have fog

**custom_vanilla_objects**

`sun`: If there is a sun in the dimension

`sun_texture`: The texture of the sun

`sun_size`: The size of the sun

`moon`: If there is a moon in the dimension

`moon_phase`: If there are moon phases

`moon_texture`: The texture of the moon

`moon_size`: The size of the moon

**Weather**

`rain`: If the rain is render

`acid_rain`: If the rain texture should be the acid one


`sunrise_color`: The color of the sunrise (decimal color)

**Stars**

`count`: The amount of stars

`colored`: If the stars should be colored

`all_days_visible`: If the stars should be rendered even when it's the day


`sky_type`: A don't know but this should stay "NONE"

`sky_objects`: A list of Sky Objects

**Sky Objects**
Sky Objects allows you to add object to the sky.

```json
{
"texture": "stellaris:textures/environment/solar_system/earth.png",
"blend": true,
"size": 8.0,
"rotation": [
60.0,
0.0,
5.0
],
"rotation_type": "DAY"
}
```

`texture`: The texture of the object

`blend`: If the object should blend

`size`: The size of the object

`rotation`: A Vector3 that is the rotation of the object

`rotation_type`: if the object should move with like the sun. Possibilities : DAY and STATIC


## Examples

You can find exemples in the github of the [Stellaris Project](https://github.com/st0x0ef/stellaris/tree/1.21/common/src/main/resources/assets/stellaris/renderer/sky)
2 changes: 2 additions & 0 deletions wiki/rocket.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,3 +45,5 @@ There are four type of Rocket Upgrades :
To applied theses upgrade, enter the rocket, open your inventory and place the upgrade in the good slot (It's one of the four slots at the bottom)

![Launch Pads](/screens/rocket.png)

Some planets are far away and need a big amount of Fuel. This can be achieve with the `Tank upgrade`.

0 comments on commit c29e1ee

Please sign in to comment.