From ae0ce5664cb0a9f01312ca7eba858257004b7ed4 Mon Sep 17 00:00:00 2001 From: nmtho <144540995+toby7002@users.noreply.github.com> Date: Wed, 29 Nov 2023 21:03:57 +0700 Subject: [PATCH] Update README.md --- README.md | 250 +++++++++++++++++++++++++++--------------------------- 1 file changed, 126 insertions(+), 124 deletions(-) diff --git a/README.md b/README.md index 6a23c51..068fa9e 100644 --- a/README.md +++ b/README.md @@ -1,124 +1,126 @@ - - - -The asynchronous PocketMine-MP plugin manager - -[![CI](https://github.com/thebigcrafter/oh-my-pmmp/actions/workflows/ci.yml/badge.svg)](https://github.com/thebigcrafter/oh-my-pmmp/actions/workflows/ci.yml) -[![Build Phar](https://github.com/thebigcrafter/oh-my-pmmp/actions/workflows/build.yml/badge.svg)](https://github.com/thebigcrafter/oh-my-pmmp/actions/workflows/build.yml) -[![State](https://poggit.pmmp.io/shield.state/oh-my-pmmp)](https://poggit.pmmp.io/p/oh-my-pmmp) -[![Downloads Total](https://poggit.pmmp.io/shield.dl.total/oh-my-pmmp)](https://poggit.pmmp.io/p/oh-my-pmmp) -[![License](https://img.shields.io/github/license/thebigcrafter/oh-my-pmmp)](https://github.com/thebigcrafter/oh-my-pmmp/blob/main/LICENSE) -[![Discord](https://img.shields.io/discord/1087729577004122112?label=discord&color=7289DA&logo=discord)](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. - -
- -
- -Table of Contents - -- [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) - -
- -# 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` `` `` - -**`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` `` - -**`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 `, default is `1`. -- To display all plugins, use the command `omp list --all`. - -#### `omp show` `` `` - -**`Permission:` `oh-my-pmmp.show`** - -Get details about a plugin (name, version, api, depends, etc.). - -#### `omp upgrade` `` `` - -**`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. + + + +The asynchronous PocketMine-MP plugin manager + +[![CI](https://github.com/thebigcrafter/oh-my-pmmp/actions/workflows/ci.yml/badge.svg)](https://github.com/thebigcrafter/oh-my-pmmp/actions/workflows/ci.yml) +[![Build plugin](https://github.com/thebigcrafter/oh-my-pmmp/actions/workflows/build.yml/badge.svg)](https://github.com/thebigcrafter/oh-my-pmmp/actions/workflows/build.yml) +[![State](https://poggit.pmmp.io/shield.state/oh-my-pmmp)](https://poggit.pmmp.io/p/oh-my-pmmp) +[![Downloads Total](https://poggit.pmmp.io/shield.dl.total/oh-my-pmmp)](https://poggit.pmmp.io/p/oh-my-pmmp) +[![License](https://img.shields.io/github/license/thebigcrafter/oh-my-pmmp)](https://github.com/thebigcrafter/oh-my-pmmp/blob/main/LICENSE) +[![Discord](https://img.shields.io/discord/1087729577004122112?label=discord&color=7289DA&logo=discord)](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. + +
+ +
+ +Table of Contents + +- [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) + +
+ +# 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` `` `` + +**`Permission:` `oh-my-pmmp.install`** + +Install a plugin with a specified version or leave it empty to install the latest one. + +#### `omp remove` `` + +**`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 `, default is `1`. +- To display all plugins, use the command `omp list --all`. + +#### `omp show` `` `` + +**`Permission:` `oh-my-pmmp.show`** + +Get details about a plugin (name, version, api, depends, etc.). + +#### `omp extract` `` + +**`Permission:` `oh-my-pmmp.extract`** + +Unphar a plugin + +#### `omp enable` `` + +**`Permission:` `oh-my-pmmp.enable`** + +Enable a disabled plugin + +#### `omp disable` `` + +**`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.