Fuzuto / oh-my-pmmp

📦 A plugin manager for PocketMine-MP downloads plugin from PocketMine-MP official plugin repository

The asynchronous PocketMine-MP plugin manager

Oh My PMMP provides commands to allow you to install plugins from Poggit. It's fast and easy to use.

Table of Contents

• Getting Started
  • Prerequisites
  • Basic installation
• Using Oh My PMMP
  • Commands
• Advanced Topics
  • Developer Mode
• How do I contribute to Oh My PMMP?
• License

Getting Started

Prerequisites

• PHP binary for PocketMine-MP 8.1+
• PocketMine-MP v5.0.0 or higher.

Basic installation

1. Download the latest version of the plugin from here.
2. Put it in the plugins folder.
3. Restart your server.

Using Oh My PMMP

Commands

Oh My PMMP provides omp command to allow you to install, upgrade, remove, etc. plugins from Poggit

omp help

Permission: oh-my-pmmp.help

List available commands.

omp version

Permission: oh-my-pmmp.version

Print plugin version.

omp install <plugin> <version>

Permission: oh-my-pmmp.install

Install a plugin with a specified version or use the word latest as a version to install the latest one.

omp remove <plugin>

Permission: oh-my-pmmp.remove

Remove a plugin.

omp update

Permission: oh-my-pmmp.update

Update cached data.

omp list

Permission: oh-my-pmmp.list

List available plugins or installed plugins.

• To display the list of plugins by page, use the command omp list <page>, default is 1.
• To display all plugins, use the command omp list --all.

omp show <plugin> <version>

Permission: oh-my-pmmp.show

Get details about a plugin (name, version, api, depends, etc.).

omp upgrade <plugin> <version>

Permission: oh-my-pmmp.upgrade

Upgrade a plugin to a specified version or use the word latest as a version to upgrade to the latest one.

NOTE: To use all commands of Oh My PMMP, use oh-my-pmmp.cmds permission.

Advanced Topics

Developer Mode

Turn on this mode in config.yml by changing devMode to true

Some features will be unlocked after developer mode is enabled:

• Download plugins as folder: Download the plugin and oh-my-pmmp will help you extract it by adding the word true after the install command. For example: omp i ExamplePlugin latest true

How do I contribute to Oh My PMMP?

Before you participate in our community, please read the Code of Conduct.

See Contributing for more details.

License

Licensed under the GNU General Public License v3.0 license.