-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
nmtho
committed
Nov 29, 2023
1 parent
f922d6e
commit ae0ce56
Showing
1 changed file
with
126 additions
and
124 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,124 +1,126 @@ | ||
| <img src="assets/icon.png" align="left" width="140px" height="140px" /> | ||
| <img align="left" width="0" height="140px" hspace="10"/> | ||
|
|
||
| The asynchronous <a href="https://pmmp.io">PocketMine-MP</a> plugin manager | ||
|
|
||
| [](https://github.com/thebigcrafter/oh-my-pmmp/actions/workflows/ci.yml) | ||
| [](https://github.com/thebigcrafter/oh-my-pmmp/actions/workflows/build.yml) | ||
| [](https://poggit.pmmp.io/p/oh-my-pmmp) | ||
| [](https://poggit.pmmp.io/p/oh-my-pmmp) | ||
| [](https://github.com/thebigcrafter/oh-my-pmmp/blob/main/LICENSE) | ||
| [](https://discord.gg/PykBfE2TZ9 | ||
| ) | ||
|
|
||
| Oh My PMMP provides commands to allow you to install plugins from [Poggit](https://poggit.pmmp.io). It's fast and easy to use. | ||
|
|
||
| <br /> | ||
|
|
||
| <details> | ||
|
|
||
| <summary>Table of Contents</summary> | ||
|
|
||
| - [Getting Started](#getting-started) | ||
| - [Prerequisites](#prerequisites) | ||
| - [Basic installation](#basic-installation) | ||
| - [Using Oh My PMMP](#using-oh-my-pmmp) | ||
| - [Commands](#commands) | ||
| - [Advanced Topics](#advanced-topics) | ||
| - [Developer Mode](#developer-mode) | ||
| - [How do I contribute to Oh My PMMP?](#how-do-i-contribute-to-oh-my-pmmp) | ||
| - [License](#license) | ||
|
|
||
| </details> | ||
|
|
||
| # Getting Started | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| - [PHP binary for PocketMine-MP](https://github.com/pmmp/PHP-Binaries/releases) 8.1+ | ||
| - [PocketMine-MP](https://github.com/pmmp/PocketMine-MP/releases) v5.0.0 or higher. | ||
|
|
||
| ## Basic installation | ||
|
|
||
| 1. Download the latest version of the plugin from [here](https://github.com/thebigcrafter/oh-my-pmmp/releases). | ||
| 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](https://poggit.pmmp.io) | ||
|
|
||
| #### `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](https://github.com/thebigcrafter/oh-my-pmmp/blob/main/CODE_OF_CONDUCT.md). | ||
|
|
||
| See [Contributing](https://github.com/thebigcrafter/oh-my-pmmp/blob/main/CONTRIBUTING.md) for more details. | ||
|
|
||
| # License | ||
|
|
||
| Licensed under the [GNU General Public License v3.0](https://github.com/thebigcrafter/oh-my-pmmp/blob/main/LICENSE) license. | ||
| <img src="assets/icon.png" align="left" width="140px" height="140px" /> | ||
| <img align="left" width="0" height="140px" hspace="10"/> | ||
|
|
||
| The asynchronous <a href="https://pmmp.io">PocketMine-MP</a> plugin manager | ||
|
|
||
| [](https://github.com/thebigcrafter/oh-my-pmmp/actions/workflows/ci.yml) | ||
| [](https://github.com/thebigcrafter/oh-my-pmmp/actions/workflows/build.yml) | ||
| [](https://poggit.pmmp.io/p/oh-my-pmmp) | ||
| [](https://poggit.pmmp.io/p/oh-my-pmmp) | ||
| [](https://github.com/thebigcrafter/oh-my-pmmp/blob/main/LICENSE) | ||
| [](https://discord.gg/PykBfE2TZ9 | ||
| ) | ||
|
|
||
| Oh My PMMP provides commands to allow you to install plugins from [Poggit](https://poggit.pmmp.io). It's fast and easy to use. | ||
|
|
||
| <br /> | ||
|
|
||
| <details> | ||
|
|
||
| <summary>Table of Contents</summary> | ||
|
|
||
| - [Getting Started](#getting-started) | ||
| - [Prerequisites](#prerequisites) | ||
| - [Basic installation](#basic-installation) | ||
| - [Using Oh My PMMP](#using-oh-my-pmmp) | ||
| - [Commands](#commands) | ||
| - [Advanced Topics](#advanced-topics) | ||
| - [Developer Mode](#developer-mode) | ||
| - [How do I contribute to Oh My PMMP?](#how-do-i-contribute-to-oh-my-pmmp) | ||
| - [License](#license) | ||
|
|
||
| </details> | ||
|
|
||
| # Getting Started | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| - [PHP binary for PocketMine-MP](https://github.com/pmmp/PHP-Binaries/releases) 8.1+ | ||
| - [PocketMine-MP](https://github.com/pmmp/PocketMine-MP/releases) v5.0.0 or higher. | ||
|
|
||
| ## Basic installation | ||
|
|
||
| 1. Download the latest version of the plugin from [here](https://github.com/thebigcrafter/oh-my-pmmp/releases). | ||
| 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](https://poggit.pmmp.io) | ||
|
|
||
| #### `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 leave it empty 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 extract` `<plugin>` | ||
|
|
||
| **`Permission:` `oh-my-pmmp.extract`** | ||
|
|
||
| Unphar a plugin | ||
|
|
||
| #### `omp enable` `<plugin>` | ||
|
|
||
| **`Permission:` `oh-my-pmmp.enable`** | ||
|
|
||
| Enable a disabled plugin | ||
|
|
||
| #### `omp disable` `<plugin>` | ||
|
|
||
| **`Permission:` `oh-my-pmmp.disable`** | ||
|
|
||
| Disable a plugin | ||
|
|
||
| `NOTE:` To use all commands of Oh My PMMP, use `oh-my-pmmp.cmds` permission. | ||
|
|
||
| # How do I contribute to Oh My PMMP? | ||
|
|
||
| Before you participate in our community, please read the [Code of Conduct](https://github.com/thebigcrafter/oh-my-pmmp/blob/main/CODE_OF_CONDUCT.md). | ||
|
|
||
| See [Contributing](https://github.com/thebigcrafter/oh-my-pmmp/blob/main/CONTRIBUTING.md) for more details. | ||
|
|
||
| # License | ||
|
|
||
| Licensed under the [GNU General Public License v3.0](https://github.com/thebigcrafter/oh-my-pmmp/blob/main/LICENSE) license. |