FamilyFriendly

FamilyFriendly Plugin

A Minecraft plugin that ensures a safe and age-appropriate chat experience by filtering inappropriate words for underage players.

Features

• Age verification system
• Chat filtering based on age
• Configurable blocked words list
• Automatic age setting on first join
• Age update command
• Configurable replacement characters

Requirements

• Minecraft Spigot/paper 1.21.X

Installation

1. Download the latest version of the plugin jar file
2. Place the jar file in your server's plugins folder
3. Restart your server

Configuration Files

blockedwords.yml

Contains the configuration for blocked words and settings:

age_threshold: 18  # Age below which words will be filtered
blocked_words:
  - word1
  - word2
  - word3
  - word4

settings:
  replace_with: "***"  # Character used to replace blocked words
  show_warning: true    # Whether to show warning messages
  warning_message: "This word is not allowed for your age group."  # Custom warning message

players.yml

Stores player ages:

# Format: player_uuid: age
# Example:
# 123e4567-e89b-12d3-a456-426614174000: 16
# 123e4567-e89b-12d3-a456-426614174001: 22

Commands

/age

• Set or update your age
• Usage: /age <your_age>
• Permission: familyfriendly.age
• Example: /age 16

/familyfriendly reload

• Reload the plugin configuration
• Usage: /familyfriendly reload
• Permission: familyfriendly.reload

How It Works

1. When a player first joins:

   • They'll see a welcome message asking for their age
   • They can type their age directly in chat to set it
   • The age must be a valid number

2. After age is set:

   • Players under the age threshold (default: 18) will have their messages filtered
   • Blocked words will be replaced with the configured replacement character (default: *** )
   • Warning messages will be shown when blocked words are attempted

3. Players can:

   • Update their age using /age <your_age> at any time
   • Chat normally once their age is set

Permissions

• familyfriendly.age: Allows players to set their age (default: true)
• familyfriendly.reload: Allows reloading the plugin configuration (default: op)

Troubleshooting

• If players can't set their age: Ensure the plugin has write permissions in the plugins folder
• If chat filtering isn't working: Check if the age_threshold in blockedwords.yml is set correctly
• If configuration changes aren't applying: Use /familyfriendly reload to reload the settings

License

This plugin is licensed under the MIT License - see the LICENSE file for details