Configuration

StarChat uses multiple YML files to keep your settings organized. Everything can be reloaded in-game without a server restart using /starchat reload.

The config.yml File

This is the master configuration file for StarChat. It controls database settings, cross-server sync, chat radiuses, and global feature toggles.

Key Settings Overview
SettingDescription
server-nameThe identifier for this server when using Redis cross-server chat (e.g., "Survival", "Lobby").
databaseSupports SQLite (local) or MySQL/MariaDB (required for cross-server data syncing).
redisEnable and configure Redis here to link chat across multiple paper/folia servers.
chat-radiusSet to -1 for global chat, or a positive integer (e.g., 100) for local spatial chat.

Formatting (format-components.yml)

StarChat utilizes MiniMessage, a powerful text formatting library standard in modern Paper plugins. This allows for gradients, hover events, click events, and standard hex colors without relying on the outdated &a legacy formatting.

Example: Group Format

formats:
  admin:
    priority: 10
    format: '<bold><gradient:#ff5e62:#ff9966>Admin</gradient></bold> <white>%player_name%</white> <gray>»</gray> <white><message></white>'
    hover-text: '<gray>Click to message <aqua>%player_name%</aqua></gray>'
    click-command: '/msg %player_name% '

Make sure your priorities are set correctly! The format with the highest priority number will be selected if a player inherits multiple groups from LuckPerms.

💡 Need Help?

If your YAML file is failing to load, you likely have an indentation error or a missing quotation mark. Copy your config into our Nebula AI Assistant and ask it to find the syntax error!