ByteClansDiscord

---

ByteClansDiscord is an official addon for ByteClans that sends Discord webhook notifications on clan events, built with JDWebHooks and Discord's Components V2.

---

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.

---

If you need help, join the Discord server.

---

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 ByteClansDiscord release from the releases page.
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:

clan-member-join:
  enabled: true
  webhook-url: ""
  username: "ByteClans WebHooks"
  avatar-url: ""
  container:
    accent-color: 0x00FF00
    spoiler: false
    components:
      - type: TEXT_DISPLAY
        content: "## ✅ Member Joined\n**{player_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

---

Contributing

1. Fork the repository.
2. Create a branch: git checkout -b feature/my-feature or git checkout -b fix/my-fix
3. Commit your changes and open a Pull Request.

Please follow the existing code style:

• Use this. for all instance field references.
• Use final on parameters, local variables and fields wherever applicable.
• This addon is intentionally scoped to Discord webhook delivery only — pull requests adding unrelated features will be rejected.

---

License

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