Skip to content

GamerDuck123/detoxify

Repository files navigation

I have opened a support discord, join now! https://discord.gg/uHm8EbfCFr

Detoxify

Detoxify is a lightweight yet powerful AI chat moderation tool that classifies messages into multiple categories, allowing you to finely tune what gets caught by the filter. Despite its performance, it uses less than 150MB of RAM, making it extremely efficient for both server and client use.


How It Works

Detoxify uses the detoxify AI model to classify chat messages. Each message is analyzed and assigned scores for categories such as:

  • Toxicity
  • Severe Toxicity
  • Obscene content
  • Threats
  • Insults
  • Identity Attacks

These scores allow you to configure thresholds and customize exactly which messages are filtered.


Installation

Server

  1. Download the correct server version of Detoxify.

  2. Place the .jar file in your plugins or mods folder.

  3. Start your server.

  4. The configuration will be located in:

    • Modded platforms: config/Detoxify
    • Plugin platforms: plugins/Detoxify

Client

  1. Download the correct client version of Detoxify.
  2. Place the .jar file in your mods folder.
  3. Any messages classified as toxic will be hidden in chat, but still logged for review.
  4. The configuration will be located in: .minecraft/config/Detoxify

Permissions

This is only on paper and spigot, on fabric and neoforge you need to be op

  1. detoxify.notify -> Gives you permissions to receive notifications when a player is flagged.
  2. detoxify.admin -> Gives you permission to receive update notifications

Configuration Options

This configuration works for both client and server. It allows fine-tuning of message thresholds and debug options:

####################################
#                                  #
#      Detoxify Configuration      #
#                                  #
####################################

# Whether or not there should be debug message
debug=false

############################
#      Value Settings      #
############################

toxicity=0.9
severe-toxicity=0.5
obscene=0.25
threat=-1.0
insult=-1.0
identity-attack=-1.0

############################
#     Message Settings     #
############################

player=§cYour message was removed for violating chat rules.
staff=§c%s's message has been removed [%s]
console=§c%s's message has been removed [%s]

Skript Support

Note: Only available for Spigot and Paper platforms

Detoxify integrates with Skript for custom chat filtering. It provides a single expression that returns true or false depending on whether a message is considered toxic:

is [the] %string% toxic
detoxify %string%

Examples

on chat:
    if detoxify message is true:
        cancel event
        send "&cThat message was blocked for toxicity!" to player
on chat:
    if is the message toxic is true:
        cancel event
        send "&cThat message was blocked for toxicity!" to player

About

Detoxify your chat locally!

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages