From b6a15c8badf6e73ff3d2a24c0f7bb09f2b855025 Mon Sep 17 00:00:00 2001
From: Etzelia <etzelia@hotmail.com>
Date: Fri, 12 Oct 2018 14:05:02 -0500
Subject: [PATCH] Moved docs to project

---
 docs/.gitignore                 |   6 ++
 docs/Makefile                   |  20 ++++
 docs/make.bat                   |  42 ++++++++
 docs/source/_static/favicon.png | Bin 0 -> 2851 bytes
 docs/source/changelog/index.rst |  10 ++
 docs/source/changelog/v1.3.rst  |  26 +++++
 docs/source/commands.rst        |  38 +++++++
 docs/source/common.rst          |   3 +
 docs/source/conf.py             | 170 ++++++++++++++++++++++++++++++++
 docs/source/index.rst           |  16 +++
 docs/source/misc.rst            |  51 ++++++++++
 docs/source/permissions.rst     |  39 ++++++++
 12 files changed, 421 insertions(+)
 create mode 100644 docs/.gitignore
 create mode 100644 docs/Makefile
 create mode 100644 docs/make.bat
 create mode 100644 docs/source/_static/favicon.png
 create mode 100644 docs/source/changelog/index.rst
 create mode 100644 docs/source/changelog/v1.3.rst
 create mode 100644 docs/source/commands.rst
 create mode 100644 docs/source/common.rst
 create mode 100644 docs/source/conf.py
 create mode 100644 docs/source/index.rst
 create mode 100644 docs/source/misc.rst
 create mode 100644 docs/source/permissions.rst

diff --git a/docs/.gitignore b/docs/.gitignore
new file mode 100644
index 0000000..ae6e71a
--- /dev/null
+++ b/docs/.gitignore
@@ -0,0 +1,6 @@
+.idea/
+*.iml
+target/
+dependency-reduced-pom.xml
+build/
+source/.doctrees/
\ No newline at end of file
diff --git a/docs/Makefile b/docs/Makefile
new file mode 100644
index 0000000..0a64ba2
--- /dev/null
+++ b/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)
\ No newline at end of file
diff --git a/docs/make.bat b/docs/make.bat
new file mode 100644
index 0000000..5051326
--- /dev/null
+++ b/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
\ No newline at end of file
diff --git a/docs/source/_static/favicon.png b/docs/source/_static/favicon.png
new file mode 100644
index 0000000000000000000000000000000000000000..0764cee11fb695d67fe600330c3830643ebdb3bc
GIT binary patch
literal 2851
zcmV+;3*7XHP)<h;3K|Lk000e1NJLTq001BW001Be1^@s6b9#F800006VoOIv0RI60
z0RN!9r;`8x010qNS#tmY9c};s9c}?J67z}x000McNliru;syu-4=EW$Bk}+M3b08;
zK~z}7t(R%6UDb8Re|w*E&$;*9d3g5?e(%}F6E?01-~eF^j#5HZfgo*Y=^(Z0hXhqk
zQz?m3HK8qPibA6*ZA#NBAF8%W8WjZ*LLm*Y+JKE6Fb-hj**w4Z{Dynq9nU=N(+@5v
zQk6=i{eRoq!}@9Mzn0b#yazq-#RL56=kDc~#qV?5!`I*5m@WUAQOKoH6#vn8KKq}C
z_!%VL>xKIsyX%I^RPpa(FTTMY1ZX))bFzu9X>Tl^z5F}R{pm}u06h4W5A&^0e*gal
z@EcFu!#_Rz902z}{-K}ClzIxuw#}P2lVus_PF(<?wWWqiGyGwIrpr^(&>r~KC!Rn3
zGiTrzAGw|H{>h8{{AX?v?W-Hx(j+}ZMmt|IA<M`~1EmzhjWJS_M0QLPCFH9nQWJnc
zNO8H|t{k}V?-$N~|L>1+@8@shJCDBfzXRO&_yL~&^uc!^HX9Y=h|t7T<RoZ@q%u`R
zr5WKkAX8v9Ei_HiIp2pYqrIbv&;-4OAySt}AqbpkC<Qk?^MxOt1-So92YBi;2mdF)
zeSiKzp8ni_aPJpC_`aN_Kc8hx>V}4<OOh}}NI_tS<V}+}ND0G$e8oi9H0m>TqA+CK
za}iP?rNGSRP#J_lh(M5Ktfqc)*HfQ8c;=z6-px0D_j>@yFTC(60CJXo>-~RmU`aQ%
z<EE9H)J=`ZiHN*}(2eki0j*7Sn)5ZxY7Vn(pi+fy=#0BIy`=$y3?r{2HAx(&#9mD5
zr}(1~ukTOm1^x7I{=>Z&o3pK306y}Ew;~>V;_llwP0oHT48uJGua8O;-XK6Xb#kVT
zQOHrOT0~xiYkMFB;W#7-Qwmj+YO8`_88}0izzHZ+O(HMB>3KA#8t8eQFbPP51R(^5
zWiVW^$;i&u=PI8P5B|;F83JTZLJIzW|8J>TM8zpW6R1=XdJ$4eLNB7!uqagWBw>n5
z6rmeoSr&1W5=K5|$-uWmA~&W`H7K=;pdiaK;xHlhW1I~iEho{lG|N<?gw!O?hKFWo
z=y{DKN=Skfp+UZ4kR%!a<z|uCPw-No@<a*W4nT)YW*8+M73PSegq*2Uo+zT}5@*B3
zv<v`-%VX?yk6;{PmJMW~Vv6vRgOS%E%TRGjzI^4dQPeO?2ARqz*Ge?nHLOYj-IT;h
zf`}xRX(2N3eV^`f4-rTj6E!qb!yoyGM4}6W;i}Ej@pbwOW6Dz{D)VKmS4YTekE^V9
zBB5qhkcLLSVv<~Pu-6?TKP8FME2at~bPRIRz$hD(CyF?}gX1{}T_QC}&eX|dhUWyN
zQ9`D`9eIq_ZDKp6)Gm_q70bt0NtZolszvmTwK0udH!%8_<H$_{XVRd0Xh8Y?8PZr$
zY!nFX5T!C~e~6aT2?ililpr+;KpZ6Gayrx7+Qd<eJN8H-#dy^r%LKJ*1-+~zq=4lW
zOg~1c2sv3p?%z30e*F#hwyOM6b(Z-Z6J#pG>3BqI9%m0OKnyBTj8<KuVM3{1q|_)7
zdojvQ(PfS}jPZRRcjU2trbp*g52xcXTpZy?KEW`c`^}To@+Nz?PEjy(T(@Hr+K%b^
zBg@^9*gRR|=*cCjD={L;$j;js3qF&-zLR>TMx|C|+#3-(A-)r!R7QQif?2sz57H=M
z@zpiP9S`G3pKQ*eaMC8fr;a+f&icrqJ+T)v9O4HdMovRYiT2UkcR!*@Dcm4pZnDOO
zg)Z0coJFXNI7&F@*_fH4JXOai<``~_G4ckT^L?bQ;q-j$jzi?e=%$8{pj~uHB*<RG
z*bbQ2^Js&JV9=qM*J;&?fS{1qksCt~r4-j~pCM6#`I~<M*AH0fjoCimV)CR%?z=0z
z_RNow7Xqrs9FQ=%tBFM5bX=UCPr)j%esMsWWMqk=x*9W4E>P>HbOtW7?J`%-H_(J&
zVEcq|LbvZAQ>8F+I%k%;Ts_-hle$b0DcbcCGp#C#8&j=XOq>hxUK%r#<*<*eBl8;R
zf{mtY6y6+@>nlFinr9OxyS7eX8XCK|OfuChGubFH*(kGRs*VtXC{F2*J({&55@5Pj
zA&3(CwnyjkWm?q&hOY6#v2*;^J^LBE0W($sqtQmUEOz@Q+S8Y5o)4)BgWCMH@LGpg
z-nc|~tV=#`kfe$?FRZb9OPh_MM=5Xe*1|f)e2%?aCz+bt!eHbf+w~H0oU+=pDHlwV
zG-c$52qBoLl~^0tG%6OGr|W3lvm}wvY`cbV6I#UrQ>T5b!Q0GFRoS|!fhaZTj~vRD
ziD~GpY>e4C-(s;dB#cs~TNMUwh$z;%+#RCr-!c72Z{!Ixr!#VW>XjlVF0L|kd=jNl
z3f6}XH(fnPqheuu5lSg6)1X?)(-}If^=)dU0wc$#KDQGq9TO#r-uQ~YqBtQ=Q`QGA
zNXTiD)ZXCwowMjkqF5i;?Atz#W#*V~*Rb7yeOFDfyfNnRi3M)lGtc_KVWL_@lY(+F
zPY@;Snwua|8BwALqnN!{O|!D`HbU14W1r2_brx3o+_7&foskQ`+J;S1P1!cnq-T4G
zzxwz`l%`A39XJGGLc!FTZdF+B46hg_QCEnSLaFRZ6CniCtqMX24xhY)$})D(w;8wr
zy^+gW-@!6-R7)mFqG(o&v};99FLoiz*n8D9osokk1X4&LRyrdV*M}4fIm*R6t%}8s
zSI;rktRTqPziXDMW`#IOxoP(t#e%`hCl?9hgj(4`lY(>08%)>Bn7YP9)nebaY06d}
zfHR95oVwIut#6Y7r!K7%MkyyQt|Q|ly)IR1c<1}B;=1jdC|f4S&R%A<KPJmE(o}I~
zd4nzO8XF^zrHwH=W?Rfnlo>icgRw`wQY2Q2lM8E9%LS_C0-b?PPLn9jq*}2savJSg
zk({nkDHZVi@Q4@1o8IjSpL_J7o6oKG|9NEl+eW^keeGTJUjG43a}T4lN7*q`BZv~#
z2M+tM*~+l7kHXq9e)QG?Q_Tuz7Q1YlX;889R4kJ;%Q(H%Bdc#=SJ6hLDczBaVd#f7
z!Eb-*Utc~0T&V*9_k8{vM}F^#=eNg+x^u1DdwqQ27%Kyt56`9S-P*?XBm6L-TFm3R
zF7Aa_SXvuk=o$mtqg^X9_5zl>BQCD?S#bsZvB#d`n33yqda-lJG;;6%@{=#$s%zSr
zcj9V4*_MC$ftxsb>hh(hUpfD^TeeResuYa9MN>>~nXED0sPOv5RZ0beda1y!nJTNj
z5kg8Xtqz!MlyLosX4PWoMNpkZcs-;hUo>>>V}JYXu}2TTwX_28;)%s~W6GZdc>LQ(
zIe6mIJIfayd-CuNju+mx)E&Kg?sAu{(^pFAbhE<94Y=dltLP3~w$HZck9~H}w-G|n
zAKG|JZyvMqxexs1w~yS>b-W+_w8=>Rw2jA}JPbh1${l+6tN-@?u^V1L*(jfyZC80~
zp+gWQEOv$%IStnj3F8#o59yD+(~08dZ~pM~eksHefUiIM8t)n4-TCm#&j2tpQ9b^N
zzkYU)kYe{lqj+(>KPHG08dZxpRorsT{M#kV-2IO~cysrTnZ{9ouYd2y{J-lfAHN%b
zKYr-;*00@p&AC7L=m+|ryzj=H0Kf8~eee0b{{rMtIv^FIfF%F`002ovPDHLkV1j3?
BadQ9w

literal 0
HcmV?d00001

diff --git a/docs/source/changelog/index.rst b/docs/source/changelog/index.rst
new file mode 100644
index 0000000..c09b957
--- /dev/null
+++ b/docs/source/changelog/index.rst
@@ -0,0 +1,10 @@
+.. include:: ../common.rst
+
+.. _qol_changelogs:
+
+Changelogs
+==========
+
+.. toctree::
+
+   v1.3 <v1.3>
\ No newline at end of file
diff --git a/docs/source/changelog/v1.3.rst b/docs/source/changelog/v1.3.rst
new file mode 100644
index 0000000..606f7cd
--- /dev/null
+++ b/docs/source/changelog/v1.3.rst
@@ -0,0 +1,26 @@
+.. include:: ../common.rst
+
+.. _qol_v1.3:
+
+QoL v1.3
+========
+
+Additions
+---------
+* `Non-spec TP Confirmation`_- Players must confirm TPs if they are not in spec.
+* `Spec-Dynmap integration`_ - Going into /spec now hides a user on the dynmap, coming out of spec returns the user to their previous hidden state
+* `Showing totals in /list`_ - The /list command now shows the total count of players online
+* `Welcome Message`_ - Server now welcomes new players to the server
+* `Hiding Audits`_ - Added permission to bypass audit for auditors of staff
+* `Console Auditing`_ - Console is now audited when running auditable commands
+
+.. _Non-Spec TP Confirmation: https://git.etztech.xyz/Etzelia/QoL/issues/1
+.. _Spec-Dynmap integration: https://git.etztech.xyz/Etzelia/QoL/issues/2
+.. _Showing totals in /list:  https://git.etztech.xyz/Etzelia/QoL/issues/3
+.. _Welcome Message: https://git.etztech.xyz/Etzelia/QoL/issues/4
+.. _Hiding Audits: https://git.etztech.xyz/Etzelia/QoL/issues/7
+.. _Console Auditing: https://git.etztech.xyz/Etzelia/QoL/issues/10
+
+Bug Fixes
+---------
+None
\ No newline at end of file
diff --git a/docs/source/commands.rst b/docs/source/commands.rst
new file mode 100644
index 0000000..3d4d86b
--- /dev/null
+++ b/docs/source/commands.rst
@@ -0,0 +1,38 @@
+.. include:: common.rst
+
+.. _qol_commands:
+
+Commands
+========
+
+``/qol`` - Base command (used for reloading with ``/qol reload``)
+
+``/colors`` - Shows a list of all Minecraft color/formatting codes.
+
+``/list`` - Shows a list of players online, split by (configurable) permissions.
+
+``/plugins`` - Shows a list of (configurable) plugins the server is using.
+
+``/history <name>`` - Returns the name history of a player. |br|
+Alias ``/names`` and ``/name``
+
+
+``/uuid <name>`` - Returns the UUID of a player.
+
+``/portal`` - Returns the coordinates where the Nether portal should be placed in the world opposite the current one.
+
+``/worldinfo`` - Shows which players are in which world, and whether they are outside a defined "soft border".
+
+``/makeme <group>`` - Sets your group via Console, regardless of other permissions.
+
+``/sudo <command>`` - Executes a command as Console.
+
+``/shadowmute <player> <time>`` - Shadow Mutes a player. Time format is ``1h2m3s`` for "1 Hour, 2 Minutes, and 3 Seconds"
+
+.. note::
+   A Shadow Mute is where the player can continue to chat and see their messages, however no one else can. |br|
+   This effectively makes them believe they are still chatting/spamming when they are not.
+
+``/whitelist <on|off|true|false|>`` - Turns Whitelist mode on or off. When in Whitelist mode, no one can connect unless they have the permission node.
+
+``/timeout <on|off|true|false|>`` - Turns Timeout mode on or off. When in Timeout mode, no one can chat unless they have the permission node.
diff --git a/docs/source/common.rst b/docs/source/common.rst
new file mode 100644
index 0000000..71f9e4d
--- /dev/null
+++ b/docs/source/common.rst
@@ -0,0 +1,3 @@
+.. |br| raw:: html
+
+    <br>
\ No newline at end of file
diff --git a/docs/source/conf.py b/docs/source/conf.py
new file mode 100644
index 0000000..515f154
--- /dev/null
+++ b/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 = 'Plugin Docs'
+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
\ No newline at end of file
diff --git a/docs/source/index.rst b/docs/source/index.rst
new file mode 100644
index 0000000..32704b4
--- /dev/null
+++ b/docs/source/index.rst
@@ -0,0 +1,16 @@
+.. include:: common.rst
+
+QoL
+====
+
+The QoL plugin was created to move anything relying on Skript into its own plugin.
+
+:download:`Example Config </../../src/main/resources/config.yml>`
+
+.. toctree::
+   :titlesonly:
+
+   changelog/index
+   commands
+   permissions
+   misc
diff --git a/docs/source/misc.rst b/docs/source/misc.rst
new file mode 100644
index 0000000..be2d8dc
--- /dev/null
+++ b/docs/source/misc.rst
@@ -0,0 +1,51 @@
+.. include:: common.rst
+
+..  _qol_misc:
+
+Miscellaneous
+=============
+
+Message Scheduler
+-----------------
+
+A list of messages that get sent to everyone at a specified frequency. |br|
+One message will get sent each time and the plugin will cycle through each message in the list before starting over.
+
+
+Command Scheduler
+-----------------
+
+A list of commands that run as Console at a specified frequency. |br|
+**Every** command is run each time.
+
+
+Ignition Causes
+---------------
+
+QoL can stop ignition from any source, via its config.
+
+
+Death Locations
+---------------
+
+QoL overrides death messages to show the location of a player's death when hovered over.
+
+
+Links
+-----
+
+QoL provides a way in the config to create commands that return a link to a URL. Handy for linking your dynmap, Discord, etc.
+
+
+TPS Alert
+---------
+
+QoL provides a way to monitor your TPS and send an alert to a Discord webhook whenever TPS falls below a configurable threshold.
+
+
+Auto Dynmap Hide
+----------------
+
+If Dynmap is detected on the server, QoL will hide a user on the dynmap when they spec. When they come out of
+spec, their previous visibility state will be restored.
+
diff --git a/docs/source/permissions.rst b/docs/source/permissions.rst
new file mode 100644
index 0000000..a97961a
--- /dev/null
+++ b/docs/source/permissions.rst
@@ -0,0 +1,39 @@
+.. include:: common.rst
+
+..  _qol_permissions:
+
+Permissions
+===========
+
+.. warning::
+   MakeMe is controlled by a list of UUIDs, so the command itself is by default given to all players.
+
+``qol.admin`` - Ability to reload the plugin
+
+``qol.uuid`` - Ability to use the UUID command
+
+``qol.history`` - Ability to use the Name History command
+
+``qol.portal`` - Ability to use the Portal command
+
+``qol.sudo`` - Ability to use the Sudo command
+
+``qol.shadowmute`` - Ability to use the Shadow Mute command
+
+``qol.auditable`` - Audits command usage
+
+``qol.auditor`` - Ability to bypass auditing when running commands on auditable
+
+``qol.tpconfirm`` - Forces a player to confirm teleports when outside spectator mode
+
+``qol.whitelist.bypass`` - Allows someone into the server when Whitelist mode is enabled
+
+``qol.whitelist.command`` - Ability to use the Whitelist command
+
+``qol.whitelist.*`` - Wildcard permission for Whitelist
+
+``qol.timeout.bypass`` - Allows someone to chat while Timeout mode is active
+
+``qol.timeout.command`` - Ability to use the Timeout command
+
+``qol.timeout.*`` - Wildcard permission for Timeout
\ No newline at end of file