An open API service indexing awesome lists of open source software.

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.

Awesome Lists containing this project

README

          





social


Latest release
Pull requests
Issues
License


Enhance your server's communication.


Modular, customizable and feature-packed.

๐Ÿงฒ Quick navigation



  1. ๐Ÿ“š Information


  2. ๐Ÿ“ฅ Installation


  3. ๐Ÿ–Š๏ธ Usage


  4. โญ๏ธ Credits

# ๐Ÿ“š 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 |






We're sponsored by Godlike, a high performance game server hosting. Check them out!