ByteClansDiscord

ByteClansDiscord

--- <p align="center"> <a href="https://www.java.com/"> <img src="https://img.shields.io/badge/Java-21+-blue" alt="Java"/> </a> <a href="https://papermc.io/"> <img src="https://img.shields.io/badge/PaperMC-1.19%2B-green" alt="PaperMC"/> </a> <a href="license"> <img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="License"/> </a> <a href="https://discord.com/invite/3K9yrZQRmS"> <img src="https://img.shields.io/discord/1350369915521204276?label=Discord&color=7289DA&logo=discord&logoColor=white" alt="Discord"/> </a> </p>

ByteClans is an official addon for ByteClans that sends Discord webhook notifications on clan events.

---

Requirements

- ByteClans (latest) - Java 21+ - Spigot 1.8.8+

---

Overview

ByteClansDiscord hooks into ByteClans' event system and dispatches fully customizable Discord webhooks whenever something happens in a clan. Each event has its own webhook URL, toggle, and component layout — configured entirely through `webhooks.yml`.

---

<p align="center"> <a href="https://discord.com/invite/3K9yrZQRmS"> <img src="https://imgur.com/DvyC4jL.png" width="600" alt="ByteSessionRestore preview"> </a> <br/> <i>If you need help, join the Discord server.</i> </p>

---

Features

- Per-event webhook with its own URL and toggle. - Built on Discord's Components V2 — containers, text displays, separators and thumbnails. - Player skin thumbnails via configurable URL (e.g. `mcstats.com/bust/{player_uuid}`). - Full markdown support in text components. - Placeholders resolved per event. - Async webhook dispatch — no server thread blocking.

---

Supported Events

| Event | Placeholders | |-----------------------|------------------------------------------------------------------------------------------------------------------| | Clan Created | `{player_name}`, `{player_uuid}`, `{clan_name}`, `{clan_uuid}`, `{owner_name}`, `{owner_uuid}` | | Clan Disbanded | `{clan_name}`, `{clan_uuid}`, `{owner_name}`, `{owner_uuid}`, `{date}` | | Member Joined | `{player_name}`, `{player_uuid}`, `{clan_name}`, `{clan_uuid}`, `{owner_name}`, `{owner_uuid}`, `{member_count}` | | Member Left | `{player_name}`, `{player_uuid}`, `{clan_name}`, `{clan_uuid}`, `{owner_name}`, `{owner_uuid}`, `{member_count}` | | Ownership Transferred | `{old_owner}`, `{old_owner_uuid}`, `{new_owner}`, `{new_owner_uuid}`, `{clan_name}`, `{clan_uuid}` | ---

Installation

1. Download the latest ByteClans release from the ByteClans. 2. Make sure ByteClans is already installed. 3. Place the JAR inside your server's `plugins/` folder. 4. Start your server — `webhooks.yml` will be generated automatically. 5. Fill in your `webhook-url` for each event and configure the components to your liking. 6. Restart.

---

Configuration

Each event is a top-level section in `webhooks.yml`: ```yaml clan-member-join: enabled: true webhook-url: "" username: "ByteClans WebHooks" avatar-url: "" container: accent-color: 0x00FF00 spoiler: false components: - type: TEXT_DISPLAY content: "## ✅ Member Joinedn{clan_name} has joined {clan_name}." - type: SEPARATOR divider: true spacing: SMALL - type: TEXT_DISPLAY content: "-# Members: {member_count}" ```

Component Types

| Type | Fields | |----------------|--------------------------------------------------| | `TEXT_DISPLAY` | `content` — supports Discord markdown | | `SEPARATOR` | `divider` (bool), `spacing` (`SMALL` | `LARGE`) | | `SECTION` | `components` (list of text lines), `thumbnail` |

Thumbnail Fields

| Field | Description | |---------------|--------------------------------------------------------| | `url` | Image URL — supports placeholders like `{player_uuid}` | | `description` | Alt text for the image | | `spoiler` | Blurs the image until clicked |

---

License

This project is released under the MIT License. You are free to use, modify, and distribute it with attribution.