forked from Minecraft/QoL
Moved docs to project
parent
8691743af9
commit
b6a15c8bad
|
@ -0,0 +1,6 @@
|
|||
.idea/
|
||||
*.iml
|
||||
target/
|
||||
dependency-reduced-pom.xml
|
||||
build/
|
||||
source/.doctrees/
|
|
@ -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)
|
|
@ -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
|
Binary file not shown.
After Width: | Height: | Size: 2.8 KiB |
|
@ -0,0 +1,10 @@
|
|||
.. include:: ../common.rst
|
||||
|
||||
.. _qol_changelogs:
|
||||
|
||||
Changelogs
|
||||
==========
|
||||
|
||||
.. toctree::
|
||||
|
||||
v1.3 <v1.3>
|
|
@ -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
|
|
@ -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.
|
|
@ -0,0 +1,3 @@
|
|||
.. |br| raw:: html
|
||||
|
||||
<br>
|
|
@ -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
|
|
@ -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
|
|
@ -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.
|
||||
|
|
@ -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
|
Loading…
Reference in New Issue