Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/4drian3d/titleannouncer

A lightweight Paper and Velocity plugin to send Titles, Actionbars, Bossbars and Chat announces with MiniMessage format.
https://github.com/4drian3d/titleannouncer

announcements minecraft-plugin minimessage paper paper-plugin papermc plugin velocity-plugin velocitypowered

Last synced: 18 days ago
JSON representation

A lightweight Paper and Velocity plugin to send Titles, Actionbars, Bossbars and Chat announces with MiniMessage format.

Awesome Lists containing this project

README

        

# TitleAnnouncer [![WorkFlow Status](https://img.shields.io/github/workflow/status/4drian3d/TitleAnnouncer/TitleAnnouncer%20Maven%20Build?&style=flat-square)](https://github.com/4drian3d/TitleAnnouncer/actions/workflows/TitleAnnouncerBuild.yml) [![Version](https://img.shields.io/github/v/release/4drian3d/TitleAnnouncer?color=FFF0&style=flat-square)](https://github.com/4drian3d/TitleAnnouncer/releases)

A lightweight plugin to send Titles, Actionbars, Bossbars and Chat Announces with the MiniMessage format to Paper 1.17.1+ servers and Velocity 3.0.2+ networks.

[![Banner](https://i.imgur.com/BhFqg82.jpg)](https://polymart.org/resource/titleannouncer.1350)

## Features
- Ability to send announcements by using titles, actionbars, bossbars, and chat messages.
- Send announcements to users in the same world you are in.
- Send announcements to a specific user.
- Test the announcement to be sent or simply send the announcement to yourself.
- Send announcements to a server on your network.
- Use of the [MiniMessage format](https://docs.adventure.kyori.net/minimessage.html#format) throughout the plugin, allowing the maximum possible customization.
- The plugin makes use of the Adventure library, allowing a native sending of messages with the best possible performance.
- Announcements with [PlaceholderAPI support](https://github.com/PlaceholderAPI/PlaceholderAPI/wiki/Placeholders) on Paper and forks
- [Velocity](https://github.com/VelocityPowered/Velocity) proxy support
- Own useful [placeholders](https://github.com/4drian3d/TitleAnnouncer/wiki/Placeholders) in Paper and Velocity
- Send sounds along with titles, actionbars and bossbars in Paper and Velocity. In order to use sounds in Velocity, you must install [Protocolize](https://www.spigotmc.org/resources/protocolize-protocollib-for-bungeecord-waterfall-velocity.63778/).

## Commands

To use the commands in Velocity, just add a "v" at the beginning of the command, for example: "/vannouncebossbar".

### Main Command



Command
Argument
Permission
Description




/announcer
[help|reload]
announcer.command
Main Command.

### Title



Command
Argument
Permission
Description




/announcetitle
(Title); (SubTitle)
announcer.title.global
Announces a Title to the entire server.


/selftitle
(Title); (SubTitle)
titleannouncer.title.self
Send a Title only to the player who has sent it.


/worldtitle
(Title); (SubTitle)
titleannouncer.title.world
Sends a title to the world in which the command was executed.


/sendtitle
(Player) (Title); (SubTitle)
titleannouncer.title.send
Sends a title to a specific player.


/servertitle
(Server) (Title); (SubTitle)
titleannouncer.title.server
Sends a title to a server on Velocity.

### Actionbar



Command
Argument
Permission
Description




/announceactionbar
(Message)
titleannouncer.actionbar.global
Announce an Actionbar to the entire server.


/selfactionbar
(Message)
titleannouncer.actionbar.self
Send an ActionBar only to the player who has sent it.


/worldactionbar
(Message)
titleannouncer.actionbar.world
Sends an actionbar to the world in which the command was executed in Paper.


/sendactionbar
(Player) (Message)
titleannouncer.actionbar.send
Sends an actionbar to a specific player.


/serveractionbar
(Server) (Message)
titleannouncer.actionbar.server
Sends an actionbar to a server on Velocity.

### Bossbar



Command
Argument
Permission
Description




/announcebossbar
(Time) (Color) (Type) (Message)
titleannouncer.bossbar.global
Announce a Bossbar to the entire server.


/selfbossbar
(Time) (Color) (Type) (Message)
titleannouncer.bossbar.self
Send a Bossbar only to the player who has sent it.


/worldbossbar
(Time) (Color) (Type) (Message)
titleannouncer.bossbar.world
Sends a Bossbar to the world in which the command was executed in Paper.


/sendbossbar
(Player) (Time) (Color) (Type) (Message)
titleannouncer.bossbar.send
Sends an Bossbar to a specific player.


/serverbossbar
(Server) (Time) (Color) (Type) (Message)
titleannouncer.bossbar.server
Sends an Bossbar to a server on Velocity.

### Chat



Command
Argument
Permission
Description




/announcechat
(Message)
titleannouncer.chat.global
Announce a Chat Message to the entire server.


/selfchat
(Message)
titleannouncer.chat.self
Send a Chat Message only to the player who has sent it.


/worldchat
(Message)
titleannouncer.chat.world
Sends a Chat Message to the world in which the command was executed in Paper.


/sendchat
(Player) (Message)
titleannouncer.chat.send
Sends an Chat Message to a specific player.


/serverchat
(Server) (Message)
titleannouncer.chat.server
Sends a Chat Message to a server on Velocity.

## Compatibility
The plugin works in [Paper](https://papermc.io/), [Airplane](https://github.com/TECHNOVE/Airplane), [Purpur](https://purpur.pl3x.net/) 1.17.1+ and [VelocityPowered](https://github.com/VelocityPowered/Velocity) 3.0.2+

It does not and will not work in Spigot or CraftBukkit. It will not work in Paper or fork versions 1.16.4 or lower.

For Paper and forks 1.16.5, use plugin version 1.16.0