Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/presentkim-pm/pluginreplacer

Replace the plugin file when the server stop!
https://github.com/presentkim-pm/pluginreplacer

Last synced: about 2 months ago
JSON representation

Replace the plugin file when the server stop!

Awesome Lists containing this project

README

        

![Version][version-badge]
[![Stars][stars-badge]][stars-url]
[![License][license-badge]][license-url]




Logo

PluginReplacer



An plugin that replace the plugin file when the server stop!

[Contact to me][author-discord] · [Report a bug][issues-url] · [Request a feature][issues-url]


## About The Project

Have you ever encountered problems while updating plugins while the server was running?
Or do you dislike waiting for the server to shut down to update plugins?

Then use this plugin!
This plugin automatically replaces plugin files in the `plugin_replace` folder when the server shuts down!

##

-----

#### Usage

1. Place the plugin phar file to be replaced in the `plugin_replace` folder (In the same directory as `plugin`
or `plugin_data`)
2. Just reboot the server!

> It works only phar file, not folder.

> Don't care about the file name because plugin analyze and process the Phar file.
> Instead, the plugin file will be renamed '{Name}_v{version}.phar'

> exmaple) When server directory is configured as below,
> ```bash
> . # pmmp directory
> ├── plugin_replace
> │ └── ExamplePlugin_v1.1.0.phar
> │
> ├── plugins
> │ ├── Another_v1.0.0.phar
> │ ├── ExamplePlugin_v1.0.0.phar
> │ └── PluginReplacer_v1.0.0.phar
> │
> └── ...
> ```
>
> Then, PluginReplacer will be replace the `ExamplePlugin_v1.0.0.phar` to `ExamplePlugin_v1.1.0.phar`
> when the server stops.
>
> ```bash
> . # pmmp directory
> ├── plugin_replace
> │ └── (nothing)
> │
> ├── plugins
> │ ├── Another_v1.0.0.phar
> │ ├── ExamplePlugin_v1.1.0.phar
> │ └── PluginReplacer_v1.0.0.phar
> │
> └── ...
> ```

##

-----

## Target software:

This plugin officially only works with [`Pocketmine-MP`](https://github.com/pmmp/PocketMine-MP/).

##

-----

## Downloads

### Download from [Github Releases][releases-url]

[![Github Downloads][release-badge]][releases-url]

##

-----

## Installation

1) Download plugin `.phar` releases
2) Move downloaded `.phar` file to server's **/plugins/** folder
3) Restart the server

##

-----

## License

Distributed under the **LGPL 3.0**. See [LICENSE][license-url] for more information

##

-----

[author-discord]: https://discordapp.com/users/345772340279508993

[poggit-ci-badge]: https://poggit.pmmp.io/ci.shield/presentkim-pm/PluginReplacer/PluginReplacer?style=for-the-badge

[poggit-version-badge]: https://poggit.pmmp.io/shield.api/PluginReplacer?style=for-the-badge

[poggit-downloads-badge]: https://poggit.pmmp.io/shield.dl.total/PluginReplacer?style=for-the-badge

[version-badge]: https://img.shields.io/github/v/release/presentkim-pm/PluginReplacer?display_name=tag&style=for-the-badge&label=VERSION

[release-badge]: https://img.shields.io/github/downloads/presentkim-pm/PluginReplacer/total?style=for-the-badge&label=GITHUB%20

[stars-badge]: https://img.shields.io/github/stars/presentkim-pm/PluginReplacer.svg?style=for-the-badge

[license-badge]: https://img.shields.io/github/license/presentkim-pm/PluginReplacer.svg?style=for-the-badge

[poggit-ci-url]: https://poggit.pmmp.io/ci/presentkim-pm/PluginReplacer/PluginReplacer

[poggit-release-url]: https://poggit.pmmp.io/p/PluginReplacer

[stars-url]: https://github.com/presentkim-pm/PluginReplacer/stargazers

[releases-url]: https://github.com/presentkim-pm/PluginReplacer/releases

[issues-url]: https://github.com/presentkim-pm/PluginReplacer/issues

[license-url]: https://github.com/presentkim-pm/PluginReplacer/blob/main/LICENSE

[project-icon]: https://raw.githubusercontent.com/presentkim-pm/PluginReplacer/main/assets/icon.png

[project-preview]: https://raw.githubusercontent.com/presentkim-pm/PluginReplacer/main/assets/preview.gif