Skip to content

Configuration

Jump to bottom
Ayush Singh edited this page Oct 24, 2026 · 1 revision

Configuration

ReinChat provides YAML configuration files that let server administrators customize chat formatting, messages, channels, player features, moderation, broadcasts, and more.

Configuration Directory

ReinChat stores its configuration files in:

plugins/ReinChat/

Channel configurations are stored separately in:

plugins/ReinChat/channels/

ReinChat creates its data directory and initializes its configuration files when the plugin starts.

Configuration Files

config.yml

The main configuration file for general plugin settings.

It includes:

  • Chat colors — Configure named solid colors and gradients available through the chat color feature.
  • AFK settings — Configure the inactivity timeout.
  • Private messages — Customize sent, received, and SocialSpy message formats.
  • Chat color menu — Customize menu titles and presentation.
  • Tag menu — Customize the tag selection menu.
  • Nickname settings — Configure nickname-related behavior and formatting.
  • Chat display settings — Configure applicable item, inventory, and ender-chest display behavior.

messages.yml

Controls the messages displayed by ReinChat.

It includes messages for commands, permissions, private messaging, tags, chat colors, channels, AFK status, and other plugin features.

You can customize message text, colors, and formatting to match your server's style.

channels/

Each YAML file in this directory defines a chat channel. The special global.yml file configures public chat and rank formatting.

channels/global.yml

Configures public chat, including:

  • Public chat command and aliases.
  • Display name.
  • Rank groups, prefixes, and chat formats.
  • Public chat filtering.
  • SocialSpy detection settings.

Other channel files

Files such as staff.yml, developer.yml, and builder.yml configure individual channels.

Channel settings can include:

  • Whether the channel is enabled.
  • Display name.
  • Command and aliases.
  • Permission to send messages.
  • Permission to read messages.
  • Message format.
  • Sound.
  • Whether chat filters apply.
  • Whether messages are logged to the console.
  • Whether SocialSpy detects channel messages.

You can customize existing channels or create additional channel files. Each file's name becomes its channel ID.

See Chat Channels for more information.

tags.yml

Defines the available chat tags.

Each tag can have:

  • A display value.
  • A permission requirement.
  • A description shown in the tag menu.

You can add, remove, or customize tags by editing their entries.

See Tags & Chat Colors for more information.

permission-bundles.yml

Defines permission bundles that group configured chat colors and tags together.

Each bundle can specify a permission, colors, and tags. The actual contents of each bundle depend on your configuration.

filters.yml

Controls chat moderation and filtering.

It includes settings for:

  • Enabling or disabling the filter system.
  • Filter bypass permissions.
  • In-game moderation alerts.
  • Discord webhook integration.
  • Anti-spam protection.
  • Link and IP filtering.
  • Capitalization filtering.
  • Custom filtering rules and their actions.

Filtering rules can block messages or censor matching content, depending on their configuration.

Security note: If you configure Discord webhook integration, keep the webhook URL private. Never publish a real webhook URL in screenshots, public configuration examples, or issue reports.

See Chat Filters for more information.

broadcasts.yml

Controls automatic and manual broadcasts.

It includes settings for:

  • Enabling or disabling broadcasts.
  • The interval between automatic broadcasts.
  • Whether broadcast messages cycle.
  • Broadcast formatting.
  • Configured broadcast messages.
  • Hover text and click actions.
  • Manual broadcast availability and permission requirements.

See Broadcasts for more information.

help.yml

Configures the help system.

It supports configurable help presentation, including:

  • Help mode.
  • Messages displayed by the help system.
  • Menu title and layout.
  • Menu sounds and filler items.
  • Configured help menu entries.
  • Permission requirements for the menu.

See the Commands page for the help command.

Formatting

ReinChat uses MiniMessage-style formatting for configurable text, including colors, gradients, decorations, and other supported text effects.

For example:

<gradient:#b00b69:#ff69b4>Welcome to the server!</gradient>

You can use formatting in applicable message strings, channel formats, prefixes, tags, and menu text.

When editing configuration files, preserve the YAML structure and indentation. Invalid YAML or incorrect values may prevent a setting from loading as intended.

Reloading Configuration

After editing configuration files, use:

/reinchat reload

This reloads ReinChat's configuration and the plugin components associated with it, including messages, channels, tags, filters, help settings, and broadcasts.

Check the server console for errors after reloading.

If a change does not take effect as expected, verify that the setting is valid and that you edited the correct file.

Troubleshooting Configuration

A configuration change does not apply

  • Make sure you edited the correct file.
  • Check the YAML indentation and syntax.
  • Confirm that the setting name and value are valid.
  • Run /reinchat reload and check the console for errors.

A channel command does not work

Check the channel's YAML file for its enabled state, command, aliases, and permission settings.

A tag or chat color is unavailable

Check its configuration entry and any associated permission or bundle requirements.

Messages display incorrectly

Review the MiniMessage formatting and YAML string syntax in the relevant configuration file.

For feature-specific instructions, see Chat Channels, Tags & Chat Colors, Chat Filters, and Broadcasts.

Clone this wiki locally