README

This virion has been adopted by axolotl-plugin-orphanage due to prolonged inactivity from its original author. It will continue to be maintained and updated to follow axolotl-pm/PocketMine-MP.

Note

This virion is primarily supported on axolotl-pm. Compatibility with other PocketMine-MP forks is not guaranteed and no support will be provided for them.

Join the axolotl-pm community for support, updates and discussion:

ConfigUpdater

Discord	Poggit	License

A handy virion for PocketMine-MP plugin developers that checks if a new version of config is available. If so then it notifies the user about the new update and updates the config.

Features

Super simple virion to be used in your plugins.
It checks if a new version of config is available and if so it then updates and notifies the user.

API

    JackMD\ConfigUpdater\ConfigUpdater::checkUpdate(Plugin $plugin, Config $config, string $configKey, int $latestVersion, string $updateMessage = "");

$plugin is the plugin whom you are calling the function from.
$config is the config you want to update.
$configKey is the version key that needs to be checked in the config.
$latestVersion is the latest version of the config. Needs to be integer.
$updateMessage is the update message that would be shown on console if the plugin is outdated.

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/ConfigUpdater/ConfigUpdater
        version: ^2.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 config is available.

axolotl-plugin-orphanage / config-updater

Maintainers

Package info

Statistics

Security