Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/ifera-mc/updatenotifier

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.
https://github.com/ifera-mc/updatenotifier

developers notify php plugin pmmp pocketmine pocketmine-plugin poggit updater virion

Last synced: 3 months ago
JSON representation

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.

Host: GitHub
URL: https://github.com/ifera-mc/updatenotifier
Owner: ifera-mc
License: lgpl-3.0
Created: 2018-12-17T20:11:49.000Z (about 6 years ago)
Default Branch: master
Last Pushed: 2024-07-29T20:17:07.000Z (6 months ago)
Last Synced: 2024-09-26T10:20:47.203Z (4 months ago)
Topics: developers, notify, php, plugin, pmmp, pocketmine, pocketmine-plugin, poggit, updater, virion
Language: PHP
Homepage:
Size: 26.4 KB
Stars: 11
Watchers: 3
Forks: 15
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # UpdateNotifier 

| Discord | Poggit | License |

|:--:|:--:|:--:|

|[![Chat](https://img.shields.io/badge/chat-on%20discord-7289da.svg)](https://discord.gg/urQt6ETgYu)|[![Poggit-CI](https://poggit.pmmp.io/ci.shield/ifera-mc/UpdateNotifier/UpdateNotifier)](https://poggit.pmmp.io/ci/ifera-mc/UpdateNotifier/UpdateNotifier)|[![GitHub license](https://img.shields.io/github/license/Ifera/UpdateNotifier.svg)](https://github.com/Ifera/UpdateNotifier/blob/master/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

```php

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](https://poggit.github.io/support/virion.html).

### Poggit Setup

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

```yml

--- 

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:

- [Sandertv](https://github.com/Sandertv)