Astral Realms Documentation Help

config.yml Reference

plugins/AstralCore/config.yml is the main configuration file. It is loaded at startup and used to connect to external services and configure server identity.

Default file

server-information: id: "server-1" host: "localhost" port: 25565 group: "default" environment: "development" redis: host: "localhost" port: 6379 password: "" database: 0 rabbitmq: host: "localhost" port: 5672 username: "guest" password: "guest" virtual-host: "/" variables: info: "<gray>[<#a2d2ff><bold>!</bold></#a2d2ff>]</gray> " warning: "<gray>[<#ffd60a><bold>!</bold></#ffd60a>]</gray> " error: "<gray>[<#ef233c><bold>!</bold></#ef233c>]</gray> " success: "<gray>[<#80ed99><bold>!</bold></#80ed99>]</gray> " disabled-autocompletion-groups: - "hub"

server-information

Identifies this server on the network.

Key

Type

Default

Description

id

String

"server-1"

Human-readable unique server name. Used as the sender ID in packets and as a Redis key prefix.

host

String

"localhost"

Hostname or IP other servers use to connect to this one. Broadcast via heartbeat packets.

port

int

25565

Minecraft port. Included in server status broadcasts.

group

String

"default"

Logical group (e.g. "lobby", "survival"). Used for load-balanced server searches.

environment

String

"development"

Deployment environment label. Exposed as %server.environment% placeholder.

redis

Credentials for the Lettuce Redis client.

Key

Type

Default

Description

host

String

"localhost"

Redis server hostname.

port

int

6379

Redis server port.

password

String

""

Redis AUTH password. Leave blank if authentication is disabled.

database

int

0

Redis logical database index (0–15).

rabbitmq

Credentials for the AMQP client.

Key

Type

Default

Description

host

String

"localhost"

RabbitMQ hostname.

port

int

5672

AMQP port.

username

String

"guest"

AMQP username.

password

String

"guest"

AMQP password.

virtual-host

String

"/"

RabbitMQ virtual host.

variables

A free-form map of MiniMessage tag variables. Every entry becomes a <key> MiniMessage tag available in any message processed by the plugin (menus, messages.yml, actions).

variables: info: "<gray>[<#a2d2ff><bold>!</bold></#a2d2ff>]</gray> " warn: "<gold>[!]</gold> "

Usage in a menu lore:

lore: - "<info>Click to open your profile."

disabled-autocompletion-groups

A list of server group names whose players are excluded from tab-completion in commands that suggest online player names (e.g. /tphere).

disabled-autocompletion-groups: - "hub" - "lobby"
23 April 2026