Skip to content
DirectionHUD

dimension-settings.json

This file contains the configurations for dimension-specific settings in DirectionHUD. These settings include dimension properties, time configurations, weather, and ratios.

Configuration

Each part of the file and its valid entries are detailed below.

dimensions

A list of dimensions and their specific configurations.

Dimension Entry

Defines the settings of a dimension, like its color, name, and time settings.
Each dimension has the following properties:

id

The unique identifier for the dimension.

Input: String

name

The display name of the dimension.

Input: String

color

The color associated with the dimension.

Input: Hex Color Code

time

Each dimension has their own time settings:

enabled

Toggles whether time settings are enabled.

Input: Boolean

weather

Configures weather-related settings.

enabled

Toggles whether weather settings are enabled.
If disabled the rest of these settings will be ignored & will not have to be entered.

Input: Boolean

night-ticks

Defines the start and end ticks for sleeping in different weather conditions.

normal, storm, thunderstorm

Each weather has an entry for the start and end ticks.

  • startTick
    The starting tick for night time in the specified weather.

    Input: Integer

  • endTick
    The ending tick for night time in the specified weather.

    Input: Integer

icons

Defines the icons used for different conditions thoughout the day.

day, stonightrm, storm, thunderstorm

Each condition has an entry for their custom icon.

Input: String

ratios

A list of dimension ratios.

Dimension Ratio Entry

Defines the coordinate scaling relationships between dimensions.
Each dimension ratio has the following properties:

dimension-1, dimension-2

The two dimensions that are being compared in the ratio.
Each dimension has the following properties:

key

The unique identifier of a dimension.

Input: String

value

The scaling value relative to the other dimension.
Ex. If dimension-1 is 2 and dimension-2 is 1, then the ratio is 2:1.

Input: Float

Default File Structure

dimension-settings.json
{
  "version": 1.0,
  "dimensions": [
    {
      "id": "minecraft:overworld",
      "name": "Overworld",
      "color": "#55FF55",
      "time": {
        "enabled": true,
        "weather": {
          "enabled": true,
          "night-ticks": {
            "normal": {
              "startTick": 12542,
              "endTick": 0
            },
            "storm": {
              "startTick": 12010,
              "endTick": 0
            },
            "thunderstorm": {
              "startTick": 0,
              "endTick": 24000
            }
          },
          "icons": {
            "day": "☀",
            "night": "☽",
            "storm": "🌧",
            "thunderstorm": "⛈"
          }
        }
      }
    },
    {
      "id": "minecraft:the_nether",
      "name": "Nether",
      "color": "#e8342e",
      "time": {
        "enabled": true,
        "weather": {
          "enabled": false
        }
      }
    },
    {
      "id": "minecraft:the_end",
      "name": "End",
      "color": "#edffb0",
      "time": {
        "enabled": true,
        "weather": {
          "enabled": false
        }
      }
    }
  ],
  "ratios": [
    {
      "dimension-1": {
        "key": "minecraft:overworld",
        "value": 1.0
      },
      "dimension-2": {
        "key": "minecraft:the_nether",
        "value": 8.0
      }
    }
  ]
}