Quick start

5-minute setup

1. Drop StarChat-X.Y.Z.jar into plugins/, start, stop.
2. Paste your license key into plugins/StarChat/settings.yml under license-key:.
3. Start again. You should see License verified.
4. Open formatting/formats.yml, map your LuckPerms group names to the existing format keys (or rename them).
5. Optionally tweak filter/chat-filter.yml thresholds.

Map a single rank

Say you have a LuckPerms group called vip. To give VIPs their own format:

formats:
  vip:
    group: vip            # LuckPerms group name (case-sensitive)
    weight: 30            # Higher = wins over default
    chat-format: vip_format

components:
  vip_format:
    '1':
      message: '<gradient:#FFD700:#FFA500>&lVIP</gradient> &f%player_name% &8» '
      hover-message: |
        &eVIP rank
        &7Joined: &f%player_first_played%
      action: SUGGEST_COMMAND:/msg %player_name%
    '2':
      message: '&f{message}'

Run a quick smoke test

/starchat reload
/lp user <yourname> parent set vip
chat hello world
# expect: VIP yourname » hello world

What's worth tuning first

• Filter sensitivity. Default thresholds are tuned for public servers — relax them for private hubs in filter/chat-filter.yml.
• Mentions. Sound and title text live in settings.yml > Features.mentions.
• Announcements. announcer/announcements.yml ships with vote/discord/store/rules — replace with your own commands.
• Minigames. Disabled by default. Flip Features.minigames.enabled: true to play.