config.yml

##Introduction

The config.yml file holds Stella's global settings: the update checker, the defaults applied to new teams, and the optional integrations (hooks) with LuckPerms, vanilla Minecraft scoreboard teams, and auto-team-on-join.

##Breakdown of the config.yml file

# Stella — plugin settings

# Checks Modrinth for a newer version on startup.
update-checker:
  enabled: true
  # Notify OPs when they join if an update is available.
  notify-ops: true

teams:
  # Default color when creating a team.
  default-color: "#FFFFFF"
  # Default priority when not specified in /stella create.
  default-priority: 0

# Optional integrations.
hooks:
  # Reflects team membership as LuckPerms inheritance groups.
  # team_groups maps team-id -> group name. Only the groups listed
  # here are touched. A player in multiple mapped teams receives multiple groups.
  # Requires LuckPerms. Download at https://luckperms.net
  luckperms:
    enabled: false
    # Example:
    #   admins: staff
    #   vip: vip
    team_groups: {}

  # Reflects teams as vanilla scoreboard teams; the nametag takes the color
  # of the primary team (highest priority). team_groups maps team-id 
  # scoreboard team name (max 16 characters, must be unique).
  minecraft_team:
    enabled: false
    # Example:
    #   admins: sb_admins
    #   vip: sb_vip
    team_groups: {}

  # Adds teamless players to a default team on join.
  # Players with the 'stella.autoteam.bypass' permission are always exempt.
  auto_team:
    enabled: false
    team: ""
    # If true, OPs are not auto-assigned.
    op_bypass: false

##Explanation

###update-checker

• enabled — when true, Stella checks Modrinth on startup for a newer version.
• notify-ops — when true, OPs are told an update is available as they join.

###teams

Defaults applied when a new team is created.

• default-color — the hex color (#RRGGBB) given to a team created without an explicit color. Change it later per team with /stella setcolor.
• default-priority — the priority assigned by /stella create <id> when you don't pass a priority argument.

###hooks

Optional integrations, each toggled independently.

• luckperms — mirrors team membership as LuckPerms groups.

  • enabled — turn the hook on/off. Requires LuckPerms.
  • team_groups — a map of team-id → LuckPerms group. Only the listed groups are touched: when a player joins a mapped team they receive the group; when they leave it's removed. A player in several mapped teams gets several groups.

• minecraft_team — mirrors teams as vanilla scoreboard teams (the ones coloring nametags and the tab list).

  • enabled — turn the hook on/off.
  • team_groups — a map of team-id → scoreboard team name. Each scoreboard name must be unique and ≤ 16 characters. The nametag takes the color of the player's primary team (highest priority).

• auto_team — drops teamless players into a default team when they join.

  • enabled — turn the hook on/off.
  • team — the team id players are added to. Must be an existing team.
  • op_bypass — if true, OPs are not auto-assigned. Players with the stella.autoteam.bypass permission are always exempt regardless of this setting.

##Team storage (teams.yml)

Teams are persisted in plugins/stella/teams.yml. You normally manage them through commands (/stella create, add, setcolor, …), but here's the structure for reference:

teams:
  red:
    priority: 2
    display-name: "Red Team"
    color: "#FF5555"
    members:
      - "f7c8b3a0-1234-4abc-9def-0123456789ab"
      - "a1b2c3d4-5678-49ef-8abc-fedcba987654"
  blue:
    priority: 1
    display-name: "Blue Team"
    color: "#5555FF"
    members: []

• The top-level key (red, blue) is the team id — always lowercase, used in commands, placeholders and the API.
• priority — integer; higher wins when a player belongs to several teams.
• display-name — the name shown to players. Set it with /stella setname.
• color — hex color (#RRGGBB). Set it with /stella setcolor.
• members — list of player UUIDs. Stella stores members by UUID only, so memberships survive name changes. Edit through /stella add / /stella remove rather than by hand.