https://github.com/myth-mc/social
Enhance your server's communication with social. Modular, customizable and feature-packed.
https://github.com/myth-mc/social
bukkit chat chat-plugin minecraft minecraft-plugin paper spigot
Last synced: about 1 month ago
JSON representation
Enhance your server's communication with social. Modular, customizable and feature-packed.
- Host: GitHub
- URL: https://github.com/myth-mc/social
- Owner: myth-MC
- License: gpl-3.0
- Created: 2024-09-23T14:22:24.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-07-14T20:53:35.000Z (8 months ago)
- Last Synced: 2025-07-15T01:03:58.118Z (8 months ago)
- Topics: bukkit, chat, chat-plugin, minecraft, minecraft-plugin, paper, spigot
- Language: Java
- Homepage: https://discord.gg/bpkwdzREcR
- Size: 1.08 MB
- Stars: 8
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
๐งฒ Quick navigation
# ๐ 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](https://docs.advntr.dev/minimessage/index.html) and [PlaceholderAPI](https://wiki.placeholderapi.com) 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, formatters...
* ๐ **No dependencies**
## โ ๏ธ Compatibility chart
| | Compatible? | Version | Notes |
|---------------------------------------------------------|-------------|---------|----------------------------------------------|
| [PaperMC](https://papermc.io/) | โ
| 1.19+ | *1 |
| [PurpurMC](https://purpurmc.org/) | โ
| 1.19+ | *1 |
| [Spigot](https://www.spigotmc.org) | โ
| 1.19+ | *1 |
| [Bukkit](https://bukkit.org) | โ
| 1.19+ | *1 |
| [Folia](https://papermc.io/software/folia) | โ
| 1.19+ | *1 |
*1: _Some features require the latest version_
## ๐ Integrations
### ๐ท๏ธ [PlaceholderAPI](https://github.com/PlaceholderAPI/PlaceholderAPI)
- Compatible with every placeholder added by PlaceholderAPI.
### ๐ฌ [DiscordSRV](https://github.com/DiscordSRV/DiscordSRV)
- Compatible with chat channels.
### ๐ท [banco](https://github.com/myth-MC/banco)
- Adds keyword `[balance]` to show balance amount in chat.
## โ Official add-ons
### ๐ค [social-chatheadfont](https://github.com/myth-MC/social-chatheadfont-addon)
- Provides compatibility with [ChatHeadFont](https://github.com/OGminso/ChatHeadFont).
# ๐ฅ Installation
1. **Download the social jar file for your platform**. You can find the latest version on [our releases page](https://github.com/myth-MC/social/releases).
2. **Add the social jar file to your server's plugin folder**. Make sure to delete any older versions of social.
3. **Fully restart your server**. Type `/stop` and start the server again [instead of using `/reload`](https://madelinemiller.dev/blog/problem-with-reload/).
# ๐๏ธ Usage
We have a simple guide on using **social** in our docs website: https://social.mythmc.ovh/docs
## โ๏ธ 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 | Replaces a literal with '***' | _configurable_ | โ
| `192.168.1.1 โก๏ธ ***` |
| Formatter | Gives a special format to a literal | _configurable_ | โ
| `**hi** โก๏ธ `**hi** |
| Emoji | Replaces a literal with a unicode input (emoji) | :emoji: | โ
| `:smile: โก๏ธ ๐` |
| Keyword | Replaces a literal with a specific component |ย [keyword] | โ
| `[balance] โก๏ธ 10.4$` |
| Placeholder | Replaces a literal with a specific component | $placeholder | โ | `$channel โก๏ธ global` |
# โญ๏ธ Credits
## ๐ซถ Special thanks _(in alphabetical order)_
| Username | Contribution |
|----------------------------------------------------|-------------------------------------------|
| [@deltartz_](https://www.instagram.com/deltartz_/) | For her great work on the logo and assets |
| Jekyll | For his bug reports and financial support |
## โ๏ธ The myth-MC Team _(in alphabetical order)_
| Username | Real name | Role |
|------------------------------------|-----------------|----------------------|
| [@U8092](https://github.com/U8092) | | Lead developer |