Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mxjosuedev/combofly
ComboFly MiniGame, plugin for Pocketmine-MP 4.x.x. (It is currently upgrading from PM3 to PM4)
https://github.com/mxjosuedev/combofly
combo combofly minigame minigame-plugin php plugin pmmp pocketmine pocketmine-mp pocketmine-mp-plugin pocketmine-php pocketmine-plugin pocketmine-plugins
Last synced: 3 months ago
JSON representation
ComboFly MiniGame, plugin for Pocketmine-MP 4.x.x. (It is currently upgrading from PM3 to PM4)
- Host: GitHub
- URL: https://github.com/mxjosuedev/combofly
- Owner: MXJosueDev
- License: mit
- Created: 2021-11-07T23:47:56.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2023-03-15T01:24:36.000Z (almost 2 years ago)
- Last Synced: 2024-10-09T23:20:32.177Z (3 months ago)
- Topics: combo, combofly, minigame, minigame-plugin, php, plugin, pmmp, pocketmine, pocketmine-mp, pocketmine-mp-plugin, pocketmine-php, pocketmine-plugin, pocketmine-plugins
- Language: PHP
- Homepage:
- Size: 155 KB
- Stars: 5
- Watchers: 1
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# ComboFly
ComboFly is an open source plugin and is made for [PocketMine-MP](https://github.com/pmmp/PocketMine-MP) 4.x.x.
It is currently upgrading from PM3 to PM4.
## Installation
Install the file named `ComboFly.phar` in the`/home/plugins/` folder, you can download this file from [Poggit](https://poggit.pmmp.io/ComboFly).
## Command
### Command info
**Name:** /combofly
**Alias:**
- /cf
### Sub-Commands List
| Command | Description | Permission |
|-|:-:|:-:|
| **/combofly help** | Get help on the sub-commands. | No permission. |
| **/combofly join** | Join the arena by means of a command. | combofly.command.join.with.command |
| **/combofly setarena** | Set where players appear in the arena. | combofly.command.setarena |
| **/combofly setlobby** | Set where players appear when exiting the arena. | combofly.command.setlobby |
| **/combofly setkit** | Configure the kit with which the players appear in the arena (The kit will be configured with your inventory). | combofly.command.setkit |
| **/combofly setjoin** | Put the JoinNPC in your current location. | combofly.command.setjoin |
| **/combofly removejoin** | Remove the JoinNPC (Hit it). | combofly.command.removejoin |
| **/combofly debug** | Get the information you need to report a bug on github (It only runs from the console). | No permission. |
## Permissions
| Permission | Description |
|-|:-:|
| **combofly.\*** | Allow to players use all ComboFly features. |
| **combofly.command.join.with.command** | Allows join the arena by means of a command. |
| **combofly.command.setarena** | Allows set where players appear in the arena. |
| **combofly.command.setlobby** | Allows set where players appear when exiting the arena. |
| **combofly.command.setkit** | Allows configure the kit with which the players appear in the arena. |
| **combofly.command.setjoin** | Allows put the JoinNPC in your current location. |
| **combofly.command.removejoin** | Allows remove the JoinNPC. |
## Scoreboard
### Tags
| Tag | Description |
|-|:-:|
| **{player_kills}** | Shows the number of player kills. |
| **{player_deaths}** | Shows the number of player deaths. |
| **{player_ping}** | Shows the current ping of the player. |
| **{player_display_name}** | Shows the name that the player has to display. |
| **{player_real_name}** | Shows the real username of the player. |
| **{playing}** | Shows the number of players currently in the arena. |
| **{spectating}** | Shows the number of spectators currently in the arena. |
| **{total_players}** | Shows the total number of spectators and players currently in the arena. |
## Entities
### Tags
#### JoinNPC
| Tag | Description |
|-|:-:|
| **{playing}** | Shows the number of players currently in the arena. |
| **{spectating}** | Shows the number of spectators currently in the arena. |
| **{total_players}** | Shows the total number of spectators and players currently in the arena. |
| **{arena_status}** | Shows the status of the arena, this will return either 'Online' or 'Offline'. |
## Features
| List |
|-|
| Fully customizable |
| Spectator mode |
| Economy Integration |
| Scoreboard Support |
| Saves Players by UUID |
| Json Provider Support |
| UI |
| Join NPC |
| Custom Kit |
## TODO's
| List |
|-|
| SQLite3 Support |
| MySQL Support |
| Tops Floating Text |
| UI configuration menus |
## Libraries
List of libraries used in this plugin.
Note: All libraries are already integrated so you don't have to do extra installations.
### Library
- [pmforms - dktapps](https://github.com/dktapps-pm-pl/pmforms)
- [ScoreboardAPI - SabyMC](https://github.com/SabyMC/Implements/blob/main/src/scoreboard/ScoreboardAPI.php)
## Developers
Please see [CONTRIBUTING](https://github.com/MXJosueDev/ComboFly/blob/PM4/CONTRIBUTING.md).
### API
- Set up the arena
```php
getWorldManager()->getWorldByName("ComboFlyArena"); /* Object with instance of `pocketmine\world\World`. */
$pos = new Position(0, 100, 0 $world); /* Object instantiated to `pocketmine\world\Position`. */
$arena->setArena($pos); /* Set the position in which players will appear in the arena. */
```
- Set up the lobby
```php
getWorldManager()->getDefaultWorld(); /* Object with instance of `pocketmine\world\World`. */
$pos = new Position(0, 100, 0 $world); /* Object instantiated to `pocketmine\world\Position`. */
$arena->setLobby($pos); /* Sets the position players will appear in when they exit the arena. */
```
- Known if arena or lobby is loaded
```php
isArenaLoaded();
$isLobbyLoaded = $arena->isLobbyLoaded();
```
- Add players or spectators to the arena
```php
getPlayerExact("MXJosuepro033"); /* Player to add. */
/* This adds the player to the arena. */
$arena->addPlayer($player);
$arena->addSpectator($player);
```
- Remove players or spectators to the arena
```php
getPlayerExact("MXJosuepro033"); /* Player to remove. */
/* This remove the player to the arena. */
$arena->quitPlayer($player);
$arena->quitSpectator($player);
```
- Know if a player is a player or a spectator in the arena
```php
getPlayerExact("MXJosuepro033"); /* Player. */
/* This returns `true` if it is and` false` if not. */
$arena->isPlayer($player);
$arena->isSpectator($player);
```
- Get the list of players, spectators, or all players
```php
getPlayers(); /* Returns an array with the list of players. */
$spectators = $arena->getSpectators(); /* Returns an array with the list of spectators. */
$all = $arena->getAllPlayers(); /* Returns an array with the list of players and spectators. */
```
- Set up the players kit when entering the arena
```php
getPlayerExact("MXJosuepro033"); /* From this variable the Inventory and the Armor Inventory are obtained. */
$arena->setKit($player); /* This sets up the arena kit. */
```
- Give the arena kit to a player
```php
getPlayerExact("MXJosuepro033"); /* Player to give the kit. */
$arena->giveKit($player); /* This resets the player's inventory and gives him the items. */
```
- Broadcast Message
```php
broadcast("Your message here.", Arena::MESSAGE); /* Global message to players and spectators in the arena. */
```
- Get Kills, Deaths and PlayerData of Player
```php
getPlayerData($player); /* It will return an object with instance of `combofly\PlayerData`. */
$playerKills = $arena->getKills($player); /* This will return the number of kills of the player. */
$playerDeaths = $arena->getDeaths($player); /* This will return the number of deaths of the player. */
```
## License
[MIT](https://choosealicense.com/licenses/mit/)