Skip to content

An example PocketMine-MP plugin to show coding styles of KygekTeam plugins

License

Notifications You must be signed in to change notification settings

KygekTeam/KygekExamplePlugin

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

23 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

KygekExamplePlugin

Poggit CI Discord

NOTICE: This plugin branch is for PocketMine-MP 4. If you are looking for the PocketMine-MP 3 version of this plugin, please visit the main branch.

An example PocketMine-MP plugin to show coding styles of KygekTeam plugins and as example plugin for PocketMine-MP. This plugin will never be released on Poggit as it only serves as an example plugin.

❓ Why This Plugin Exists

This plugin serves as an example plugin for PocketMine-MP in addition to PMMP's PocketMine-MP example plugin. This plugin also serves as an example of the application of KygekTeam plugin coding standards (for more information, visit the PHP Coding Standards page in KygekTeam Docs).

❔ What Does This Plugin Do

This example plugin broadcasts a message to the server whenever a player chats with a delay by utilizing PocketMine-MP delayed task. Broadcasting can be enabled or disabled through the /exampleplugin command or directly in the config.yml file. The broadcasted message and delay can also configured through the config.yml file. The configuration file gets reloaded whenever a player chats regardless of the enable broadcasting settings.

✅ Features

  • Uses the KygekTeam PHP Coding Standards syntax
  • PocketMine-MP 4 support (Check out the PM4 branch)
  • Enable or disable through the /exampleplugin command or directly in the config.yml file
  • Broadcast prefix can be enabled or disabled through the config.yml file
  • Configurable broadcast message and delay
  • Configuration file gets updated automatically when a newer configuration file is available

🔧 Installation

Follow the steps below if you want to test this plugin in your PocketMine-MP server:

  1. 🔽 Download the latest version from GitHub Releases or Poggit CI below:
  2. 📁 Drop the downloaded KygekExamplePlugin.phar plugin file into your PocketMine-MP server's plugins directory.
  3. 🔄 Restart your server and you're ready to test the plugin!

🔐 Commands & Permissions

Command Description Permission Default Aliases
/exampleplugin Command to enable or disable broadcast message when a player chats kygekexampleplugin.cmd true /expl, /ep

🧾 Planned Features

You can request for a feature to be added in a future update here!

➕ Additional Info

KygekExamplePlugin is an example plugin by KygekTeam and licensed under GPL-3.0.

  • Join our Discord server here for latest news and support from KygekTeam.
  • If you found bugs or want to give suggestions, please visit here or join our Discord server.
  • We accept all contributions! If you want to contribute please make a pull request in here.