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 0000000..0764cee Binary files /dev/null and b/docs/source/_static/favicon.png differ diff --git a/docs/source/changelog/index.rst b/docs/source/changelog/index.rst new file mode 100644 index 0000000..d98b334 --- /dev/null +++ b/docs/source/changelog/index.rst @@ -0,0 +1,11 @@ +.. include:: ../common.rst + +.. _qol_changelogs: + +Changelogs +========== + +.. toctree:: + :maxdepth: 1 + + 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 `` - Returns the name history of a player. |br| +Alias ``/names`` and ``/name`` + + +``/uuid `` - 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 `` - Sets your group via Console, regardless of other permissions. + +``/sudo `` - Executes a command as Console. + +``/shadowmute