Moved documentation into project

docs/.gitignore

@@ -0,0 +1,6 @@
+.idea/
+*.iml
+target/
+dependency-reduced-pom.xml
+build/
+source/.doctrees/

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = JavaDocs
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/make.bat

@@ -0,0 +1,42 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=source
+set BUILDDIR=build
+set SPHINXPROJ=JavaDocs
+
+if "%1" == "" goto help
+if "%1" == "html" goto clean
+
+:build
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.http://sphinx-doc.org/
+	exit /b 1
+)
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+
+:clean
+%SPHINXBUILD% -M clean %SOURCEDIR% %BUILDDIR% %SPHINXOPTS%
+goto build
+
+:end
+popd

docs/source/changelog/index.rst

@@ -0,0 +1,11 @@
+.. include:: ../common.rst
+
+.. _minecraftmanager_changelogs:
+
+Changelogs
+==========
+
+.. toctree::
+   :maxdepth: 1
+
+   v1.4 <v1.4>

docs/source/changelog/v1.4.rst

@@ -0,0 +1,17 @@
+.. include:: ../common.rst
+
+.. _minecraftmanager_v1.4:
+
+QoL v1.4
+========
+
+Additions
+---------
+* Updates to EtzCore
+
+Bug Fixes
+---------
+* `In-game staff chat bug`_- Second line of in-game staff chat is white when the message is sent from MCM.
+
+
+.. _In-game staff chat bug: https://git.etztech.xyz/Etzelia/MinecraftManagerPlugin/issues/1

docs/source/commands.rst

@@ -0,0 +1,66 @@
+.. include:: common.rst
+
+.. _minecraftmanager_commands:
+
+Commands
+========
+
+
+Minecraft Manager
+-----------------
+``/minecraftmanager <sub-command> <arg1> <arg2> ...``
+
+``/mcm <sub-command> <arg1> <arg2> ...``
+
+Sub-Commands
+~~~~~~~~~~~~
+``help`` - Show the help message.
+
+``port`` - Shows the port that MCM is listening on.
+
+``register`` - Allows a player to register for the web app.
+
+``report`` - Runs a report on all entities in the world, for use with the MCM online report.
+
+
+Application
+-----------
+
+``/application <sub-command> <arg1>``
+
+``/app <sub-command> <arg1>``
+
+Sub-Commands
+~~~~~~~~~~~~
+``search`` - Searches for matching applications. You can use partial names to search. If only one application is found, this command acts as though you are using ``info``.
+
+``info`` - Gets specific information for a given application. Can be given a name or application ID.
+
+.. note::
+    ``accept`` and ``deny`` only work with IDs. This is to verify the correct application is being acted on.
+
+``accept`` - Accepts an application by ID.
+
+``deny`` - Denies an application by ID.
+
+``clear`` - Clears a denied application's status. This is to ensure that players cannot spam applications once denied.
+
+
+Apply
+-----
+``/apply`` - Initiates the application process.
+
+
+Rules
+-----
+``/rules`` - Shows the current rules defined in the plugin's config.yml
+
+
+Ticket
+------
+``/ticket <message>`` - Used to send in a help ticket.
+
+
+Warning
+-------
+``/warning <player> [<severity>] <message>`` - Gives a warning to a player. If [<severity>] is not one of "L", "M", or "H" it will be automatically set to "L".

docs/source/common.rst

@@ -0,0 +1,3 @@
+.. |br| raw:: html
+
+    <br>

docs/source/conf.py

@@ -0,0 +1,170 @@
+# -*- coding: utf-8 -*-
+#
+# Configuration file for the Sphinx documentation builder.
+#
+# This file does only contain a selection of the most common options. For a
+# full list see the documentation:
+# http://www.sphinx-doc.org/en/master/config
+
+# -- Path setup --------------------------------------------------------------
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#
+
+
+# -- Project information -----------------------------------------------------
+
+project = 'Minecraft Manager Plugin'
+copyright = '2018, Etzelia'
+author = 'Etzelia'
+
+# The short X.Y version
+version = '1.0'
+# The full version, including alpha/beta/rc tags
+release = '1.0'
+
+
+# -- General configuration ---------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#
+# needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
+# ones.
+extensions = [
+    'sphinx.ext.doctest',
+    'sphinx.ext.todo',
+    'sphinx.ext.coverage',
+    'sphinx.ext.ifconfig',
+    'sphinx.ext.autodoc',
+]
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix(es) of source filenames.
+# You can specify multiple suffix as a list of string:
+#
+# source_suffix = ['.rst', '.md']
+source_suffix = '.rst'
+
+html_show_sourcelink = False
+
+# The master toctree document.
+master_doc = 'index'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#
+# This is also used if you do content translation via gettext catalogs.
+# Usually you set "language" from the command line for these cases.
+language = None
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+# This pattern also affects html_static_path and html_extra_path .
+exclude_patterns = ['common.rst', 'template.rst']
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+
+# -- Options for HTML output -------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages.  See the documentation for
+# a list of builtin themes.
+#
+html_theme = 'sphinx_rtd_theme'
+
+# Path to the favicon
+html_favicon = '_static/favicon.png'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further.  For a list of options available for each theme, see the
+# documentation.
+#
+# html_theme_options = {}
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = []
+
+# Custom sidebar templates, must be a dictionary that maps document names
+# to template names.
+#
+# The default sidebars (for documents that don't match any pattern) are
+# defined by theme itself.  Builtin themes are using these templates by
+# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
+# 'searchbox.html']``.
+#
+# html_sidebars = {}
+
+
+# -- Options for HTMLHelp output ---------------------------------------------
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'JavaDocsdoc'
+
+
+# -- Options for LaTeX output ------------------------------------------------
+
+latex_elements = {
+    # The paper size ('letterpaper' or 'a4paper').
+    #
+    # 'papersize': 'letterpaper',
+
+    # The font size ('10pt', '11pt' or '12pt').
+    #
+    # 'pointsize': '10pt',
+
+    # Additional stuff for the LaTeX preamble.
+    #
+    # 'preamble': '',
+
+    # Latex figure (float) alignment
+    #
+    # 'figure_align': 'htbp',
+}
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title,
+#  author, documentclass [howto, manual, or own class]).
+latex_documents = [
+    (master_doc, 'JavaDocs.tex', 'Java Plugin Documentation',
+     'Etzelia', 'manual'),
+]
+
+
+# -- Options for manual page output ------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+    (master_doc, 'javadocs', 'Java Plugin Documentation',
+     [author], 1)
+]
+
+
+# -- Options for Texinfo output ----------------------------------------------
+
+# Grouping the document tree into Texinfo files. List of tuples
+# (source start file, target name, title, author,
+#  dir menu entry, description, category)
+texinfo_documents = [
+    (master_doc, 'JavaDocs', 'Java Plugin Documentation',
+     author, 'JavaDocs', 'One line description of project.',
+     'Miscellaneous'),
+]
+
+
+# -- Extension configuration -------------------------------------------------
+
+# -- Options for todo extension ----------------------------------------------
+
+# If true, `todo` and `todoList` produce output, else they produce nothing.
+todo_include_todos = True

docs/source/index.rst

@@ -0,0 +1,15 @@
+.. include:: common.rst
+
+Minecraft Manager
+=================
+
+The Minecraft Manager plugin was created as a partner piece of the Minecraft Manager Web App. |br|
+Documentation for the Django app can be found `here <http://docs.etztech.xyz/minecraftmanager/>`_.
+
+:download:`Example Config </../../src/main/resources/config.yml>`
+
+.. toctree::
+   :maxdepth: 1
+
+   commands
+   permissions

docs/source/permissions.rst

@@ -0,0 +1,48 @@
+.. include:: common.rst
+
+..  _minecraftmanager_permissions:
+
+Permissions
+===========
+
+
+
+
+Basic
+-----
+
+``minecraftmanager.use`` - Allows the use of ``/mcm port`` and ``/mcm reload``.
+
+``minecraftmanager.guest`` - This is how MCM figures out who is a "guest". This is used in the event that a player is accepted but isn't online, so all commands are ran next time they come online.
+
+.. warning::
+    ``minecraftmanager.guest`` **must** be removed (negated) once a player is member, otherwise the commands will execute each time they log in.
+
+``minecraftmanager.apply`` - Allows the use of ``/apply``.
+
+.. warning::
+    ``minecraftmanager.apply`` should probably be revoked once the player has been accepted. |br| 
+    Otherwise, the player could continue to re-apply. (Even though it would never register again)
+
+``minecraftmanager.ticket`` - Allows the use of ``/ticket``.
+
+----
+
+Staff
+-----
+
+``minecraftmanager.application.search`` - Allows the use of ``/application search``.
+
+``minecraftmanager.application.action`` - Allows the use of ``/application accept`` and ``/application deny``.
+
+.. note::
+	``minecraftmanager.application.*`` will give both of the above nodes.
+
+``minecraftmanager.staff`` - Allows a player to use Staff Chat (if enabled) and receive Staff messages from MCM.
+
+``minecraftmanager.register`` - Allows the use of ``/mcm register`` to register for the web application.
+
+``minecraftmanager.*`` - All permissions for MCM.
+
+.. note::
+	``minecraftmanager.*`` also gives the ``minecraftmanager.apply`` node, which should probably be revoked in normal use cases.