Home

MCSF Documentation

Welcome to the documentation for MCSF, a powerful chat filtering and moderation plugin for Spigot servers. This documentation provides detailed information about the plugin's features, configuration options, commands, permissions, and more.

Table of Contents

1. Introduction
2. Installation
3. Configuration
4. Commands
5. Permissions
6. Storage Configuration
7. API Usage
8. Troubleshooting
9. Support

Introduction

MCSF (Minecraft Chat Security Filter) is designed to help server administrators maintain a safe and friendly chat environment. It provides advanced chat filtering capabilities, allowing you to block or moderate offensive language, spam, advertisements, and more.

Key features of MCSF:

• Real-time chat filtering with various filtering methods.
• Customizable settings for different filter checks.
• Support for different languages and locales.
• Integration with external plugins like DiscordSRV.
• Storage options for storing filter data.

Installation

To install MCSF, follow these steps:

1. Ensure that you have a Spigot server running with Java 8 or higher.
2. Download the MCSF plugin JAR file from the official source.
3. Place the JAR file in the plugins folder of your server directory.
4. Restart the server to load the plugin.

Configuration

MCSF provides a configuration file named settings.yml. This file allows you to customize various aspects of the plugin's behavior, including language settings, filter checks, replacement strings, and more. Refer to the Configuration guide for detailed information on each configuration option.

Commands

MCSF offers several commands to manage and configure the plugin. These commands provide control over filter settings, player exemptions, reloads, and more. For a complete list of available commands and their usage, refer to the Commands guide.

Permissions

MCSF utilizes permissions to grant or restrict access to its commands and features. By assigning permissions to players or groups, you can define who can manage the plugin's settings, bypass filters, check the filter status, and more. Consult the Permissions guide for an overview of all available permissions and their descriptions.

Storage Configuration

MCSF supports different storage options for storing filter data, including SQLite and MySQL. The storage.yml file allows you to configure the database settings, such as database flavor, username, password, port, and more. Refer to the Storage Configuration guide for detailed instructions on configuring the storage options.

API Usage

MCSF provides an API (Application Programming Interface) that allows developers to interact with the plugin programmatically. This API enables integration with other plugins, customization of filter behavior, and more. The API Usage guide provides detailed information on how to utilize the MCSF API in your own plugins.

Troubleshooting

Encountering issues or errors while using MCSF? The Troubleshooting guide provides solutions to common problems, error messages, and other troubleshooting tips. If you're facing difficulties, make sure to check this guide for assistance.

Support

If you need further assistance or have any questions, feel free to reach out for support. You can visit the official MCSF website or contact the plugin developers through the provided channels. The Support guide contains information on how to get support for MCSF.

---

With this documentation, you should have a comprehensive understanding of MCSF and be able to configure and utilize its features effectively. If you need more specific information or have any further inquiries, please refer to the corresponding sections in this documentation or seek support from the MCSF community. Happy chat filtering and moderation with MCSF!