Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/evolsoft/broadcaster
Advanced Broadcasting plugin for PocketMine-MP
https://github.com/evolsoft/broadcaster
php plugin pocketmine-mp
Last synced: 7 days ago
JSON representation
Advanced Broadcasting plugin for PocketMine-MP
- Host: GitHub
- URL: https://github.com/evolsoft/broadcaster
- Owner: EvolSoft
- License: mit
- Created: 2014-12-27T14:56:00.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2021-09-04T18:54:32.000Z (about 3 years ago)
- Last Synced: 2024-09-26T10:04:24.028Z (7 days ago)
- Topics: php, plugin, pocketmine-mp
- Language: PHP
- Size: 72.3 KB
- Stars: 17
- Watchers: 12
- Forks: 23
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Broadcaster
Advanced Broadcasting plugin for PocketMine-MP
[](http://gestyy.com/er3dEU)
## Category
PocketMine-MP plugins
## Requirements
PocketMine-MP API 3.0.0
## Overview
**Broadcaster** is an advanced Broadcasting plugin for PocketMine-MP.
With Broadcaster you can set custom message, popup and title broadcasts. You can also send messages with /sm, popups with /sp and titles with /st commands.
This plugin let you also customize colors (you can use the & sign instead of § for text format), prefixes, suffixes and intervals.
**EvolSoft Website:** https://www.evolsoft.tk
***This Plugin uses the New API. You can't install it on old versions of PocketMine.***
## Donate
Please support the development of this plugin with a small donation by clicking [:dollar: here](https://paypal.me/Flavius12).
Your small donation will help me paying web hosting, domains, buying programs (such as IDEs, debuggers, etc...) and new hardware to improve software development. Thank you :smile:
## Documentation
**Configuration (config.yml):**
```yaml
---
# Available tags for broadcast messages, popups and titles:
# - {MAXPLAYERS}: Show the maximum number of players supported by the server
# - {TOTALPLAYERS}: Show the number of all online players
# - {PREFIX}: Show prefix
# - {SUFFIX}: Show suffix
# - {TIME}: Show current time
# Available tags for /sendmessage, /sendpopup and /sendtitle format:
# - {MESSAGE}: Show message
# - {MAXPLAYERS}: Show the maximum number of players supported by the server
# - {TOTALPLAYERS}: Show the number of all online players
# - {PREFIX}: Show prefix
# - {PLAYER}: Message receiver
# - {SENDER}: Show sender name
# - {SUFFIX}: Show suffix
# - {TIME}: Show current time
# Extra tag for titles:
# - {SUBTITLE}: Add subtitle (the text after this tag will be the content of the subtitle)
# Prefix
prefix: "&9[&eBroadcaster&9]"
# Suffix
suffix: "[A]"
# Date\Time format (replaced in {TIME}). For format codes read http://php.net/manual/en/datetime.formats.php
datetime-format: "H:i:s"
# Message broadcast
message-broadcast:
# Enable message broadcast
enabled: true
# Broadcast interval (in seconds)
time: 15
# Command /sendmessage format
command-format: "&e[{TIME}] {PREFIX} {SUFFIX} &a{SENDER}&e>&f {MESSAGE}"
# Broadcast messages
messages:
- "&e[{TIME}] {PREFIX}&f 1st message"
- "&e[{TIME}] {PREFIX}&f 2nd message"
- "&e[{TIME}] {PREFIX}&f 3rd message"
# Popup broadcast
popup-broadcast:
# Enable popup broadcast
enabled: true
# Popup broadcast interval (in seconds)
time: 15
# Popup duration (in seconds)
duration: 5
# Command /sendpopup format
command-format: "&a{SENDER}&e>>&f {MESSAGE}"
# Popup broadcast messages
messages:
- "&aWelcome to your server"
- "&d{TOTALPLAYERS} &eof &d{MAXPLAYERS} &eonline"
- "&bCurrent Time: &a{TIME}"
# Title broadcast
title-broadcast:
# Enable title broadcast
enabled: true
# Title broadcast interval
time: 30
# Command /sendtitle format
command-format: "&d{MESSAGE}"
# Title broadcast messages
messages:
- "&aWelcome to your server!{SUBTITLE}&bGood game!"
- "&eHello player!"
...
```
**Commands:**
/broadcaster - Broadcaster commands (aliases: [bc, broadcast])
**Permissions:**
-
broadcaster.* - Broadcaster permissions tree.
-
broadcaster.info - Let player read info about Broadcaster.
-
broadcaster.reload - Let player reload Broadcaster.
-
broadcaster.sendmessage - Let player send messages to players with /sendmessage command.
-
broadcaster.sendpopup - Let player send popups to players with /sendpopup command.
-
broadcaster.sendpopup - Let player send titles to players with /sendtitle command.
## API
Almost all our plugins have API access to widely extend their features.
To access Broadcaster API:
*1. Define the plugin dependency in plugin.yml (you can check if Broadcaster is installed in different ways):*
```yaml
depend: [Broadcaster]
```
*2. Include Broadcaster API in your plugin code:*
```php
//Broadcaster API
use Broadcaster\Broadcaster;
```
*3. Access the API by doing:*
```php
Broadcaster::getAPI()
```