Nuit

https://wiki.nuit.flashyreese.me/
Admin
Nuit is a skybox customization system that defines a format outlining a set of rules for custom sky...
Tokens:6,681
Snippets:89
Trust Score:4.9
Update:4 months ago
Show doc for...
Tokens:
Raw
### Query Documentation Index via GET Request

Source: https://wiki.nuit.flashyreese.me/llms.txt

Use this method to ask specific questions about the documentation. Append the 'ask' parameter with your natural language question to the documentation index URL.

```http
GET https://wiki.nuit.flashyreese.me/specification.md?ask=<question>
```

--------------------------------

### X-Range for Second Skybox

Source: https://wiki.nuit.flashyreese.me/

This example defines the x-range for a subsequent skybox, starting where the previous one ends. It illustrates how to create sequential skybox rendering based on coordinate ranges.

```json
"xRanges": [{"min": 4, "max": 8}]
```

--------------------------------

### X-Range for Skybox Transition

Source: https://wiki.nuit.flashyreese.me/

This example shows a simple x-range definition for a skybox, specifying the minimum (inclusive) and maximum (exclusive) coordinates. This is useful for defining transitions between different skyboxes.

```json
"xRanges": [{"min": 0, "max": 4}]
```

--------------------------------

### Skybox Properties Configuration

Source: https://wiki.nuit.flashyreese.me/

This snippet shows a comprehensive example of skybox properties, including layer, fade, rotation, transition durations, fog, sunSkyTint, and visibleUnderwater settings. It demonstrates nested object structures for fade and rotation.

```json
"properties": {
  "layer": 1,
  "fade": {
    "duration": 24000,
    "alwaysOn": false,
    "keyFrames": {
      "0": 0.0,
      "6000": 0.75,
      "18000": 1.0
      }
  },
  "rotation": {
    "speed": 0.866,
    "mapping": {
      "0": [0.0, 0.0, 0.0],
      "6000": [0.0, 90.0, 0.0]
      },
    "axis": {"0": [0.0, 0.0, 90.0]},
    "skyboxRotation": true
  },
  "transitionInDuration": 200,
  "transitionOutDuration": 300,
  "fog": {
    "modifyColors": true,
    "red": 0.84,
    "green": 0.91,
    "blue": 0.97,
    "modifyDensity": true,
    "density": 1.0,
    "showInDenseFog": true
    },
  "sunSkyTint": true,
  "visibleUnderwater": false
}
```

--------------------------------

### Skybox Rendering Conditions Example

Source: https://wiki.nuit.flashyreese.me/

This JSON object defines the conditions under which a skybox should be rendered. It includes specifications for worlds, dimensions, weather, biomes, coordinate ranges (x, y, z), and player effects. The 'excludes' field can invert the specified conditions.

```json
"conditions": {
  "worlds": {"entries": ["minecraft:overworld"]},
  "dimensions": {"entries": ["my_datapack:custom_world"]},
  "weather": {"entries": ["rain", "thunder"]},
  "biomes": {
    "entries": ["minecraft:plains", "minecraft:forest", "minecraft:river"],
    "excludes": true
    },
  "xRanges": {"entries": [{"min": -100.0, "max": 100.0}]},
  "yRanges": {"entries": [{"min": -128.0, "max": 150.0}, {"min": 200.0, "max": 320.0}]},
  "zRanges": {"entries": [{"min": -150.0, "max": 150.0}]},
  "effects": {"entries": ["minecraft:jump_boost", "minecraft:speed"]
}
}
```

--------------------------------

### Show Sun Configuration

Source: https://wiki.nuit.flashyreese.me/

Enables or disables the rendering of the sun.

```json
"showSun": true
```

--------------------------------

### Show Moon Configuration

Source: https://wiki.nuit.flashyreese.me/

Enables or disables the rendering of the moon.

```json
"showMoon": true
```

--------------------------------

### Show Stars Configuration

Source: https://wiki.nuit.flashyreese.me/

Enables or disables the rendering of stars.

```json
"showStars": true
```

--------------------------------

### Decorations Configuration

Source: https://wiki.nuit.flashyreese.me/

This configuration enables the display of the sun, moon, and stars with customizable properties for layer, fade, rotation, and fog. It is intended for clear weather conditions in the overworld.

```json
{
  "schemaVersion": 1,
  "type": "nuit:decorations",
  "showSun": true,
  "showMoon": true,
  "showStars": true,
  "properties": {
    "layer": 5,
    "fade": {
      "alwaysOn": true,
      "duration": 24000,
      "keyFrames": {}
      },
    "rotation": {
      "speed": 1.0,
      "mapping": {"0": [0.0, 0.0, 0.0]},
      "axis": {"0": [90.0, 0.0, 0.0]},
      "skyboxRotation": false
      },
    "transitionInDuration": 10,
    "transitionOutDuration": 15,
    "fog": {
      "modifyColors": false, "red": 1.0, "green": 1.0, "blue": 1.0,
      "modifyDensity": false, "density": 1.0,
      "showInDenseFog": true
      },
    "sunSkyTint": false
  },
  "conditions": {
    "worlds": {"entries": ["minecraft:overworld"]},
    "dimensions": {"entries": []},
    "weather": {"entries": ["clear"]},
    "biomes": {"entries": []},
    "xRanges": {"entries": []},
    "yRanges": {"entries": []},
    "zRanges": {"entries": []},
    "effects": {"entries": []}
  }
}
```

--------------------------------

### Animatable Textures Configuration for Skyboxes

Source: https://wiki.nuit.flashyreese.me/

Configures multiple animatable textures for a multi-textured skybox. Each animation requires a texture, UV range, grid dimensions, and duration settings. Frame-specific durations can override the default.

```json
"animatableTextures": [
  {
    "texture": "nuit:sky/anim_texture_1.png",
    "uvRange": {
      "minU": 0.25,
      "minV": 0.25,
      "maxU": 0.5,
      "maxV": 0.5
    },
    "gridColumns": 2,
    "gridRows": 4,
    "duration": 50,
    "frameDuration": {"1": 20, "5": 10}
  },
  {
    "texture": "nuit:sky/anim_texture_2.png",
    "uvRange": {
      "minU": 0.3333,
      "minV": 0.6666,
      "maxU": 0.2,
      "maxV": 0.4
    },
    "gridColumns": 3,
    "gridRows": 5,
    "duration": 10,
    "frameDuration": {"1": 30, "5": 40}
  }
]
```

--------------------------------

### Custom Skybox Blend Configuration

Source: https://wiki.nuit.flashyreese.me/specification.md

Configure a custom blend type using specific OpenGL source factors, destination factors, and blend equations. This allows for fine-grained control over how the skybox blends with the background.

```json
"blend": {
  "type" : "custom",
  "blender": {
    "sFactor": 0,
    "dFactor": 769,
    "equation": 32774,
    "redAlphaEnabled": true,
    "greenAlphaEnabled": true,
    "blueAlphaEnabled": true,
    "alphaEnabled": false
  }
}
```

--------------------------------

### Sun Texture Configuration

Source: https://wiki.nuit.flashyreese.me/

Specifies the texture for the sun. Uses the default Minecraft sun texture.

```json
"sun": "minecraft:textures/environment/sun.png"
```

--------------------------------

### Moon Texture Configuration

Source: https://wiki.nuit.flashyreese.me/

Specifies the texture for the moon. Uses the default Minecraft moon texture.

```json
"moon": "minecraft:textures/environment/moon_phases.png"
```

--------------------------------

### Square Textured Sky Configuration

Source: https://wiki.nuit.flashyreese.me/

This configuration defines a square textured sky with specific properties like layer, fade duration, rotation, and fog settings. It applies to clear or rainy weather in the overworld.

```json
{
  "schemaVersion": 1,
  "type": "nuit:square-textured",
  "texture": "nuit:sky/sky1.png",
  "blend": {"type" : "normal"},
  "properties": {
    "layer": 1,
    "fade": {
      "alwaysOn": false,
      "duration": 24000,
      "keyFrames": {
        "500": 0.0,
        "1500": 1.0,
        "10500": 1.0,
        "11500": 0.0
        }
      },
    "rotation": {
      "speed": 0.0,
      "mapping": {"0": [0.0, 0.0, 0.0]},
      "axis": {"0": [0.0, 0.0, 0.0]}
      },
    "transitionInDuration": 10,
    "transitionOutDuration": 15,
    "fog": {
      "modifyColors": true, "red": 0.0, "green": 0.4, "blue": 0.5,
      "modifyDensity": true, "density": 1.0,
      "showInDenseFog": true
      },
    "sunSkyTint": false
  },
  "conditions": {
    "worlds": {"entries": ["minecraft:overworld"]},
    "dimensions": {"entries": []},
    "weather": {"entries": ["clear", "rain"]},
    "biomes": {"entries": []},
    "xRanges": {"entries": []},
    "yRanges": {"entries": []},
    "zRanges": {"entries": []},
    "effects": {"entries": []}
  }
}
```

--------------------------------

### Skybox Fade Keyframes Configuration

Source: https://wiki.nuit.flashyreese.me/

This snippet illustrates how to configure keyframes for the skybox fade effect, specifying opacity at different times of the day. Ensure opacity values are between 0 and 1 and times do not exceed the fade duration.

```json
"keyFrames": {
      "0": 0.0,
      "6000": 1.0,
      "18000": 1.0
      }
```

--------------------------------

### Schema Version

Source: https://wiki.nuit.flashyreese.me/

The schema version object is required for the skybox configuration.

```json
"schemaVersion": 1
```

--------------------------------

### Square-Textured Skybox Texture Path

Source: https://wiki.nuit.flashyreese.me/

Specifies the directory for the texture file used in a square-textured skybox.

```json
"texture": "nuit:sky/skybox.png"
```

--------------------------------

### Custom Blend Mode Configuration

Source: https://wiki.nuit.flashyreese.me/

Configures the skybox to use a 'custom' blend type with specific OpenGL factors and equations. Alpha states can be individually enabled or disabled.

```json
{
  "blend": {
    "type" : "custom",
    "blender": {
      "sFactor": 0,
      "dFactor": 769,
      "equation": 32774,
      "redAlphaEnabled": true,
      "greenAlphaEnabled": true,
      "blueAlphaEnabled": true,
      "alphaEnabled": false
    }
  }
}
```

--------------------------------

### Normal Blend Mode

Source: https://wiki.nuit.flashyreese.me/

Configures the skybox to use the 'normal' blend type. This is a preset blend mode.

```json
{
  "blend": {
    "type" : "normal"
  }
}
```

--------------------------------

### Decoration Skybox Type

Source: https://wiki.nuit.flashyreese.me/

Enables the display of the Sun, Moon, and Stars using the 'nuit:decorations' type.

```json
"type": "nuit:decorations"
```

--------------------------------

### Monocolor Skybox Color Configuration

Source: https://wiki.nuit.flashyreese.me/

Defines the color properties for a monocolor skybox. Ensure red, green, and blue values are between 0 and 1.

```json
"color": {"red": 0.84, "green": 0.91, "blue": 0.72, "alpha": 1.0}
```

--------------------------------

### Square Textured Skybox Type

Source: https://wiki.nuit.flashyreese.me/

Defines a square textured skybox using a 3:2 aspect ratio texture file.

```json
"type": "nuit:square-textured"
```

--------------------------------

### Overworld Skybox Type

Source: https://wiki.nuit.flashyreese.me/

Sets the skybox to display the overworld's skybox using the 'nuit:overworld' identifier.

```json
"type": "nuit:overworld"
```

--------------------------------

### Skybox Rendering Conditions

Source: https://wiki.nuit.flashyreese.me/specification.md

This JSON object defines the conditions under which a skybox should render. It includes specifications for worlds, dimensions, weather, biomes, coordinate ranges, and player effects. The 'excludes' property can invert the conditions.

```json
"conditions": {
  "worlds": {"entries": ["minecraft:overworld"]},
  "dimensions": {"entries": ["my_datapack:custom_world"]},
  "weather": {"entries": ["rain", "thunder"]},
  "biomes": {
    "entries": ["minecraft:plains", "minecraft:forest", "minecraft:river"],
    "excludes": true
    },
  "xRanges": {"entries": [{"min": -100.0, "max": 100.0}]},
  "yRanges": {"entries": [{"min": -128.0, "max": 150.0}, {"min": 200.0, "max": 320.0}]},
  "zRanges": {"entries": [{"min": -150.0, "max": 150.0}]},
  "effects": {"entries": ["minecraft:jump_boost", "minecraft:speed"]}
}
```

--------------------------------

### End Skybox Type

Source: https://wiki.nuit.flashyreese.me/

Configures the skybox to display the End's skybox using the 'nuit:end' identifier.

```json
"type": "nuit:end"
```

--------------------------------

### Multi-Textured Skybox Type

Source: https://wiki.nuit.flashyreese.me/

Specifies a multi-textured skybox for animation, using a grid of textures arranged in a single texture atlas. Frames are ordered top to bottom, then left to right. Texture atlas size should not exceed 8192x8192 pixels.

```json
"type": "nuit:multi-textured"
```

--------------------------------

### Monocolor Skybox Type

Source: https://wiki.nuit.flashyreese.me/

Specifies a monocolor skybox, displaying a single plain color for the entire skybox. The 'nuit:monocolor' identifier can be namespaced.

```json
"type": "nuit:monocolor"
```
Tokens:
Raw