diff --git a/README.md b/README.md index edfaae1..79fb8c2 100644 --- a/README.md +++ b/README.md @@ -1 +1,165 @@ -# 1vs1 + + +

1vs1

+ +
+ + discord + + + license + + + poggit-ci + +

+ ✔️ Simple setup +
+ ✔️Multi arena support +
+ ✔️ Fast, without lags +
+ ✔️ Last PocketMine API support +
+ +
+ +### Releases: + +| Version | Zip Download | Phar Download | +| --- | --- | --- | +| 1.0.0 | [GitHub](https://github.com/GamakCZ/1vs1/archive/1.0.0.zip) | [GitHub](https://github.com/GamakCZ/1vs1/releases/download/1.0.0/1vs1_v1.0.0.phar) | +
+ +- **Other released versions [here](https://github.com/GamakCZ/1vs1/releases)** +- **All developement builds on poggit [here](https://poggit.pmmp.io/ci/GamakCZ/1vs1/1vs1)** + +
+

How to setup?

+
+ + -

Installation:

+ 1. Download latest release or sucess. build + 2. Upload it to your server folder /plugins/ + 3. Restart the server + +-

Create and setup an arena:

+1. Create an arena using `/1vs1 create ` +2. Join the setup mode (command `/1vs1 set `) +3. There are setup commands (they are without `/`), you can use them to set the arena + +- _Setup commands_: + +| Command | Description | +| --- | --- | +| help | Displays all setup commands | +| done | Is used to exit setup mode | +| level `` | Sets arena game level | +| spawn `` | Sets arena spawn position | +| joinsign | Update joinsign | +| enable | Enable the arena | + +
+

Commands:

+
+
+ +

+ +```yaml +Commands: + /1vs1 help: + Description: Displays all OneVsOne commands + Permission: 1vs1.cmd.help (OP) + /1vs1 create: + Description: Create new arena + Permission: 1vs1.cmd.create (OP) + Usage: /1vs1 set + /1vs1 remove: + Description: Remove arena + Permission: 1vs1.cmd.remove (OP) + Usage: /1vs1 remove + Note: Changes will be after restart + /1vs1 set: + Description: Command allows setup arena + Permission: 1vs1.cmd.set (OP) + Usage: /1vs1 set + Note: This command can be used only in-game + /1vs1 arenas: + Description: Displays list of all arenas + Permission: 1vs1.cmd.arenas (OP) +``` +

+ +
+

Permissions

+
+
+ +

+ +```yaml +1vs1.cmd: + description: Permissions for all OneVsOne commands + default: op + children: + 1vs1.cmd.help: + description: Permission for /1vs1 help + default: op + 1vs1.cmd.create: + description: Permission for /1vs1 create + default: op + 1vs1.cmd.remove: + description: Permission for /1vs1 remove + default: op + 1vs1.cmd.set: + description: Permission for /1vs1 set + default: op + 1vs1.cmd.arenas: + description: Permission for /1vs1 arenas + default: op + +``` +

+ +
+

API

+
+
+ +

Events:

+ +- [PlayerArenaWinEvent](https://github.com/GamakCZ/1vs1/blob/master/1vs1/src/onevsone/event/PlayerArenaWinEvent.php) + +```php +/** + * Arena constructor. + * @param Server $server + * @param Plugin $plugin + */ + public function __construct(Server $server, Plugin $plugin) { + $server->getPluginManager()->registerEvents($this, $plugin); + } + +/** + * @param PlayerArenaWinEvent $event + */ + public function onWin(PlayerArenaWinEvent $event) { + $player = $event->getPlayer(); + $this->addCoins($player, 100); + $player->sendMessage("§a> You won 100 coins!"); + } + +/** + * @param Player $player + * @param int $coins + */ + public function addCoins(Player $player, int $coins) {} +``` + +
+

Credits

+
+ +
- Icon made by Nikita Golubev from www.flaticon.com is licensed by CC 3.0 BY
+