¶ 📚 DeluxeAnnounce API Reference
Welcome to the DeluxeAnnounce API documentation. Here, you'll find a comprehensive list of available classes in the API, organized by module. Each section describes the main functionalities provided by these classes, helping you maximize the features of the API.
You can download the Deluxe Announce API JAR file here: https://stn-studios.dev/deluxe-announce-api
Note for Spigot Users:
This API is fully compatible with Spigot and Paper servers. You can use the provided classes and events for custom player welcome handling.BungeeCord Support Coming Soon:
We're working on adding BungeeCord support, so expect additional functionality soon for networked servers!
¶ 🔹 General Classes
| Class | Description |
|---|---|
Avatar |
Main class for managing avatars in the API. |
Exclusive function of our plugin.
¶ 📢 Announcement Module (events.announce)
Handles the execution of announcements in different formats within the server.
| Class | Description |
|---|---|
EventCommandAnnounce |
Main controller for custom announcements. |
EventCommandAnnounceActionbar |
Sends messages to the player's action bar. |
EventCommandAnnounceBossbar |
Uses the BossBar to display announcements. |
EventCommandAnnouncePrivate |
Sends private announcements to specific players. |
EventCommandAnnounceToast |
Displays announcements as a "toast" notification. |
EventCommandAnnounceWorld |
Sends announcements to players in specific worlds. |
¶ 📌 Enums (events.announce.enums for (Toast/Achievements))
| Enum | Description |
|---|---|
RecipientType |
Defines the recipients of the announcement (ALL_PLAYERS, TARGET). |
¶ 💰 Donation Module (events.donation)
Manages donation-related announcements within the server.
| Class | Description |
|---|---|
AllPlayersEventDonationCommand |
Sends donation announcements to all players. |
PlayerEventDonationCommand |
Notifies a specific player about a donation. |
¶ 🎉 Giveaway Module (events.giveaway)
Manages giveaway events within the server.
| Class | Description |
|---|---|
GiveawayCommandEvent |
Handles giveaway events. |
¶ 📌 Enums (events.giveaway.enums)
| Enum | Description |
|---|---|
EventState |
Represents different giveaway states (active, completed, etc.). |
¶ 🎥 Streaming Module (events.streaming)
Provides integration with streaming platforms for live announcements.
| Class | Description |
|---|---|
EventAnnounceLive |
Manages live event announcements. |
LiveEventWaitTime |
Controls wait times between live streaming announcements. |
¶ 📌 Enums (events.streaming.enums)
| Enum | Description |
|---|---|
LiveState |
Represents live event states (waiting, ongoing, finished). |
Platform |
Defines supported platforms for streaming announcements (YouTube, Twitch, etc.). |
¶ ⏳ Automated Tasks Module (events.tasks)
Manages scheduled automated announcements.
| Class | Description |
|---|---|
AutomaticAnnouncementEvent |
Handles scheduled automatic announcements. |
¶ 📌 Enums (events.tasks.enums)
| Enum | Description |
|---|---|
AdType |
Defines the type of automated announcement (text, action, bossbar, etc.). |
¶ 👋 Welcome Module (events.welcome)
Handles welcome events for new players and specific ranks.
| Class | Description |
|---|---|
EventWelcome |
Manages general welcome messages. |
EventFirstJoinWelcome |
Triggers events when a player joins for the first time. |
EventRankWelcomeLeave |
Handles welcome and leave messages based on ranks. |
¶ 📌 Enums (events.welcome.enums for ranks)
| Enum | Description |
|---|---|
EventType |
Defines the types of welcome events (JOIN, LEAVE, WORLD_CHANGE). |
¶ 🛠 Utilities (utils)
Auxiliary classes for API functionality.
| Class | Description |
|---|---|
AnnounceUtils |
Contains utility functions for announcement management. |
¶ 📜 Example Code
¶ 🔹 How to send my player's skin with a custom message?
Simple! Just copy and paste this:
public Avatar api = new Avatar();
api.sendAvatar(player, getConfig().getStringList("AVATAR"), AvatarType.PREMIUM);
¶ 🔹 More Placeholders
Here is an example of how the class would look like:
public class STNMain extends JavaPlugin implements Listener {
@Override
public void onEnable() {
saveDefaultConfig();
if (Bukkit.getPluginManager().isPluginEnabled("DeluxeAnnounce")) {
getServer().getPluginManager().registerEvents(this, this);
}
}
@EventHandler
public void sendAvatar(PlayerJoinEvent event) {
Avatar api = new Avatar();
Player player = event.getPlayer();
// AvatarType.PREMIUM -> Only sends the player's premium skins.
// AvatarType.CRACKED -> Uses SkinsRestorer API for non-premium servers.
// AvatarType.NORMAL -> Sends a normal message without an avatar.
// Supports PlaceholderAPI placeholders in normal messages
api.sendAvatar(player, getConfig().getStringList("AVATAR"), AvatarType.PREMIUM);
// Add more custom placeholders
List<String> list = plugin.getConfig().getStringList("AVATAR");
list.replaceAll(s -> s
.replace("{Text}", "Custom placeholder!")
.replace("{Text Two}", "Custom placeholder two!"));
api.sendAvatar(player, list, AvatarType.PREMIUM);
}
}
¶ 🔹 Config.yml Example
AVATAR:
- '&7- <gradient:#63ff73:#ff598b:#a3fff9:#4aaeff>Support for gradient colors.'
- '&7- <rainbow>Support for rainbow colors</rainbow>'
- '&7- <color:#ff1f6d>Hex</color> <color:#fffc4f>color</color> <color:#38afff>support</color>'
- ''
- '<center>&7PlaceholderAPI support</center>'
- ' &b❑ &fPlayer: &a%player_name%'
- ' &b❑ &fUptime: &a%server_uptime%'
- ' &b❑ &fPlayer IP: &a%player_ip%'
¶ 📌 As shown in the chat:
With this structured documentation, your API wiki will look professional, easy to navigate, and informative for developers. 🚀 Let me know if you want any further refinements!