Skip to content

Latest commit

 

History

History
48 lines (33 loc) · 1.67 KB

README.md

File metadata and controls

48 lines (33 loc) · 1.67 KB
Raw

UpdateNotifier

Discord Poggit License
Chat Poggit-CI GitHub license

A handy virion for PocketMine-MP plugin developers that checks if a new release for a plugin is available on Poggit. If so then it notifies the user about the new release.

Features

  • Super simple virion to be used in your plugins.
  • It checks if a new release for a plugin is available on Poggit. If so then it notifies the user about the new release.

API

JackMD\UpdateNotifier\UpdateNotifier::checkUpdate($pluginName, $pluginVersion);
  • $pluginName is the name of the plugin whose update you want to check.
  • $pluginVersion is the current version of the plugin whose update you want to check.

  • For information regarding how to use a virion in a plugin please refer here.

Poggit Setup

Edit the .poggit.yml in your repository and set it up like shown below.

--- 
branches:
- master
projects:
  PLUGIN_NAME:
    libs:
      - src: ifera-mc/UpdateNotifier/UpdateNotifier
        version: ^3.0.0
...

Disclaimer

This plugin is designed to be used only by PocketMine-MP developers who wish to provide their users with the info of when an update to the plugin is available.

Credits: