Biome Indicator 1.0.0

Permissions

• biomeindicator.use -- Allows players to see the biome indicator UI and use the toggle command

Commands

• /biome -- Toggles the biome indicator UI on or off for the player
• /biome info -- Displays current biome and temperature in chat without toggling the UI

Configuration

{
  "Version": "1.0.0",
  "Toggle UI Chat Command": "biome",
  "Update Interval In Seconds (How often to refresh biome and temperature)": 1.0,
  "Temperature Unit (Celsius or Fahrenheit)": "Celsius",
  "User Interface Settings": {
    "Show UI By Default For New Players": true,
    "Panel Anchor Min": "0 1",
    "Panel Anchor Max": "0 1",
    "Panel Offset Min": "40 -100",
    "Panel Offset Max": "170 -40",
    "Panel Background Color (Hex)": "#000000",
    "Text Color (Hex)": "#FFFFFF",
    "Arctic Biome Color (Hex)": "#A8D4FF",
    "Tundra Biome Color (Hex)": "#8BC48B",
    "Temperate Biome Color (Hex)": "#4A9C4A",
    "Arid Biome Color (Hex)": "#D4A574",
    "Jungle Biome Color (Hex)": "#2D8C3C",
    "Biome Name Font Size": 14,
    "Temperature Display Font Size": 14,
    "Hot Temperature Icon Sprite Path": "assets/icons/hot.png",
    "Cold Temperature Icon Sprite Path": "assets/icons/cold.png",
    "Cold Temperature Threshold (Show cold icon when temperature is at or below this value)": 10.0,
    "Hot Temperature Threshold (Show hot icon when temperature is at or above this value)": 25.0
  },
  "Chat Notification Settings": {
    "Send Chat Message When Player Enters New Biome": true,
    "Chat Message Prefix": "<color=#5af>[BiomeIndicator]</color>"
  }
}

General Settings

• Toggle UI Chat Command -- The chat command players use to toggle the UI on/off or check their current biome
• Update Interval In Seconds -- How frequently (in seconds) the plugin checks and updates biome and temperature (lower values are more responsive but use slightly more resources)
• Temperature Unit -- Whether to display temperature in Celsius or Fahrenheit

User Interface Settings

• Show UI By Default For New Players -- Whether the UI is enabled by default for players who haven't toggled it yet
• Panel Anchor Min -- Anchor point for the UI panel (format: "x y" where 0,0 is bottom-left and 1,1 is top-right)
• Panel Anchor Max -- Second anchor point for the UI panel (set both to same value to anchor to a corner)
• Panel Offset Min -- Pixel offset from anchor point for the bottom-left corner of the panel
• Panel Offset Max -- Pixel offset from anchor point for the top-right corner of the panel
• Panel Background Color (Hex) -- Background color for the UI panel (automatically applied with 50% transparency)
• Text Color (Hex) -- Color for the temperature text display
• Arctic Biome Color (Hex) -- Color used for Arctic biome name and accent elements
• Tundra Biome Color (Hex) -- Color used for Tundra biome name and accent elements
• Temperate Biome Color (Hex) -- Color used for Temperate biome name and accent elements
• Arid Biome Color (Hex) -- Color used for Arid biome name and accent elements
• Jungle Biome Color (Hex) -- Color used for Jungle biome name and accent elements
• Biome Name Font Size -- Font size for the biome name display
• Temperature Display Font Size -- Font size for the temperature value display
• Hot Temperature Icon Sprite Path -- Unity asset path for the icon shown when temperature is hot
• Cold Temperature Icon Sprite Path -- Unity asset path for the icon shown when temperature is cold
• Cold Temperature Threshold -- Temperature (in Celsius) at or below which the cold icon is shown
• Hot Temperature Threshold -- Temperature (in Celsius) at or above which the hot icon is shown

Chat Notification Settings

• Send Chat Message When Player Enters New Biome -- Whether to send a chat message when players enter a different biome
• Chat Message Prefix -- Prefix shown before biome change notifications in chat (supports Rust color tags)

Stored Data

{
  "Player Preferences": {
    "76561198012345678": {
      "UI Enabled": true
    },
    "76561198087654321": {
      "UI Enabled": false
    }
  }
}

Localization

{
  "Error.NoPermission": "You do not have permission to use this command.",
  "Biome.Changed": "You entered the <color={0}>{1}</color> biome. Temperature: {2}",
  "Biome.Current": "Current biome: <color={0}>{1}</color>. Temperature: {2}",
  "UI.Enabled": "Biome indicator enabled.",
  "UI.Disabled": "Biome indicator disabled."
}