📚 Information

social 🦜 is a fully modular plug-in focused on enhancing your server's communication without affecting the gameplay experience. It is developed using modern APIs, providing a simple but powerful tool for server owners and developers. Everything can be configured, including messages.

🤔 Features

• ✨ Fully compatible with MiniMessage and PlaceholderAPI to have great-looking messages
• 🗣️ Channel-based chat provider. You can add or remove channels according to your server's needs. For example, you could have a global and a staff channel
• 😲 Reactions that appear above a player's head with nice animations
• 🧵 Chat replies and threads. Players can click on a message to reply to it.
• 🛡️ Group chat channels. Players can create their own group channel with /group. Server owners can see group messages with Social Spy.
• 😎 Emoji support in a very similar way as Discord: :emoji_name:
• ‼️ Mentions that work with usernames and nicknames.
• 🔗 Server links. Available since Minecraft 1.21, server links are a great way of sharing external resources with your players in the pause menu.
• 📢 Built-in announcements with a configurable interval. Can broadcast messages through the action bar
• 🤫 Private messages with social spy for staff members
• 🖌️ Advanced text formatting with bold, italics, underline and more options
• 🤬 Chat filters that block IPs, URLs or words. Even in private messages
• 🌊 Flood/spam prevention
• ☕️ Developer-friendly API with countless possibilities. Developers can add custom channels, reactions, emojis, filters, keywords...
• 👀 No dependencies

⚠️ Compatibility chart

	Compatible?	Version	Notes
PaperMC	✅	1.16+	Reactions are available from 1.20 onwards
PurpurMC	✅	1.16+	Reactions are available from 1.20 onwards
Spigot	✅	1.16+	Reactions are available from 1.20 onwards
Bukkit	✅	1.16+	Reactions are available from 1.20 onwards
Folia	❌

🔌 Integrations

🏷️ PlaceholderAPI

• Compatible with every placeholder added by PlaceholderAPI.

💬 DiscordSRV

• Compatible with chat channels

🐷 banco

• Adds keyword [balance] to show balance amount in chat.

➕ Official add-ons

👤 social-chatheadfont

• Provides compatibility with ChatHeadFont.

🖊️ Usage

🔧 First run

When you run social for the very first time it will automatically generate two files:

• 'settings.yml' contains general settings
• 'messages.yml' contains configurable messages

You can disable any feature by modifying settings.yml

✏️ Key concepts

💬 Parsers

social provides a set of powerful built-in tools in the form of parsers. Parsers are rules that modify text accordingly. Here's a list of parser types:

	Description	Format	Triggerable by players?	Example
Filter	Replace expressions or words with '***'	configurable	✅	192.168.1.1 ➡️ ***
Emoji	Replaces a word with a unicode input (emoji)	:emoji:	✅	:smile: ➡️ 😄
Keyword	Replaces a word with a specific component	[keyword]	✅	[balance] ➡️ 10.4$
Placeholder	Replaces a word with a specific component	$placeholder	❌	$channel ➡️ global