Geoffrey-Django/GeoffreyApp/docs/source/plugin.rst

30 lines
823 B
ReStructuredText

.. 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