Added plugin to docs

doc_update
Joey Hines 2020-01-08 15:06:32 -06:00
parent 2329dab84f
commit 7018e83ddc
2 changed files with 31 additions and 0 deletions

View File

@ -17,3 +17,4 @@ bases, shops, items for sale, tunnels, towns, public farms and more!
commands
models
bot_setup
plugin

View File

@ -0,0 +1,30 @@
.. plugin:
*****************
GeoffreyMC Plugin
*****************
GeoffreyMC is a plugin for Spigot Minecraft servers that can access the GeoffreyAPI. It implements all commands
in the API. Compared to the Discord bot or the website, it has slightly less information but is easier to access
while playing.
Settings
++++++++
.. code-block:: yaml
# GeoffreyAPI Settings
geoffrey_api:
# Geoffrey API Key
key: ''
# Geoffrey API Base Url (e.g. test.zerohighdef.com/GeoffreyApp/api/)
api_base_url: ''
# Geoffrey Base Url (e.g. test.zerohighdef.com)
base_url: ''
Permissions
+++++++++++
* ``geoffrey.add`` - Ability to add entries to Geoffrey
* ``geoffrey.search`` - Ability to use Search commands in Geoffrey
* ``geoffrey.register`` - Ability to register for Geoffrey