Installation

Follow these simple steps to install and set up SolarityChat on your Minecraft server.

Prerequisites

Before installing, ensure your server meets the following requirements:

  • Spigot or Paper: Version 1.20.1 or higher.
  • Java: Version 17 or higher.
  • Optional (Recommended):
    • PlaceholderAPI: To use custom placeholders in chat formats and GUIs.
    • LuckPerms: For permission-based prefixes and chat formats.
    • Vault: For economy integration (balance in hover text).
    • LiteBans: For automatic mutes and bans based on chat filter triggers.

Installation Steps

  1. Download: Obtain the SolarityChat.jar file.
  2. Upload: Place the jar file into your server's /plugins/ folder.
  3. Restart: Start or restart your server to generate the configuration files.
  4. Verify: Check the console or use /plugins in-game to ensure SolarityChat is loaded correctly.
  5. Configure: Navigate to the /plugins/SolarityChat/ directory to customize your settings.

Initial Setup

Once installed, we recommend following these setup steps:

  1. Configure your Discord Webhook in config.yml to receive filter alerts.
  2. Adjust the Chat Formats in chat/format.yml to match your server's style.
  3. Enable or disable Chat Channels as needed in config.yml.
  4. Define any custom Chat Colors in chat/colors.yml.
  5. Set up your Chat Filters in chat/filters.yml.

After making changes to any configuration files, you can reload the plugin in-game using: /solaritychat reload