diff --git a/HEADER b/HEADER new file mode 100644 index 0000000..3c36b77 --- /dev/null +++ b/HEADER @@ -0,0 +1,15 @@ +MiniGames - A mini-games plugin for spigot +Copyright (C) 2023 Kristian Knarvik (EpicKnarvik97) + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +This program is distributed in the hope that it will be useful, +but WITHOUT ANY WARRANTY; without even the implied warranty of +MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +GNU General Public License for more details. + +You should have received a copy of the GNU General Public License +along with this program. If not, see . \ No newline at end of file diff --git a/README.md b/README.md index fae91ce..555992c 100644 --- a/README.md +++ b/README.md @@ -1,37 +1,58 @@ -# Dropper +# MiniGames -This is a plugin for a dropper mini-game (try to reach the bottom without hitting any obstacles). -To create an arena, simply use `/droppercreate `, where \ is simply the name used to differentiate and +This plugin adds several mini-games. +To create a dropper arena, simply use `/droppercreate `, where \ is simply the name used to differentiate +and recognize the arena. Your location will be used as the spawn location for anyone joining the dropper arena. To start playing, simply use `/dropperjoin `, where \ is the same as you specified upon creation. -To modify +To modify the arena, use `/dropperedit `. ## Permissions -| Node | Description | -|----------------|----------------------------------------------------| -| dropper.admin | Gives all permissions. | -| dropper.join | Allows a player to participate in dropper arenas. | -| dropper.create | Allows a player to create a new dropper arena. | -| dropper.edit | Allows a player to edit an existing dropper arena. | -| dropper.remove | Allows a player to remove a dropper arena. | +The only permission normal players will need is `minigames.join` which is set to true by default. + +| Node | Description | +|--------------------------|------------------------------------------------------| +| minigames.admin | Gives all permissions. | +| minigames.dropper | Gives all dropper-related permissions. | +| minigames.parkour | Gives all parkour-related permissions. | +| minigames.join | Allows a player to participate in mini-game arenas. | +| minigames.join.dropper | Allows a player to participate in dropper arenas. | +| minigames.join.parkour | Allows a player to participate in parkour arenas. | +| minigames.create | Allows a player to create a new mini-game arena. | +| minigames.create.dropper | Allows a player to create a new dropper arena. | +| minigames.create.parkour | Allows a player to create a new parkour arena. | +| minigames.edit | Allows a player to edit an existing mini-game arena. | +| minigames.edit.dropper | Allows a player to edit an existing dropper arena. | +| minigames.edit.parkour | Allows a player to edit an existing parkour arena. | +| minigames.remove | Allows a player to remove a mini-game arena. | +| minigames.remove.dropper | Allows a player to remove a dropper arena. | +| minigames.remove.parkour | Allows a player to remove a parkour arena. | ## Commands | Command | Alias | Arguments | Description | |----------------------------------------|----------|-----------------------------|-------------------------------------------------------------------------------------| +| /miniGamesReload | /mreload | | Reloads all data from disk. | +| /miniGamesLeave | /mleave | | Leaves the current mini-game. | | /dropperList | /dlist | | Lists available dropper arenas. | -| [/dropperJoin](#dropperJoin) | /djoin | \ \[mode] | Joins the selected arena. | -| /dropperLeave | /dleave | | Leaves the current dropper arena. | +| [/dropperJoin](#dropperjoin) | /djoin | \ \[mode] | Joins the selected arena. | | /dropperCreate | /dcreate | \ | Creates a new dropper arena with the given name. The spawn is set to your location. | | /dropperRemove | /dremove | \ | Removes the specified dropper arena. | -| [/dropperEdit](#dropperEdit) | /dedit | \ \