diff --git a/GeoffreyApp/docs/source/index.rst b/GeoffreyApp/docs/source/index.rst index 27cd409..dd8c3ef 100644 --- a/GeoffreyApp/docs/source/index.rst +++ b/GeoffreyApp/docs/source/index.rst @@ -17,3 +17,4 @@ bases, shops, items for sale, tunnels, towns, public farms and more! commands models bot_setup + plugin diff --git a/GeoffreyApp/docs/source/plugin.rst b/GeoffreyApp/docs/source/plugin.rst new file mode 100644 index 0000000..561885f --- /dev/null +++ b/GeoffreyApp/docs/source/plugin.rst @@ -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 \ No newline at end of file