Etzelia
parent
b711813bee
commit
62a49f6d77
|
|
@ -0,0 +1,64 @@
|
|||
# Mixtape
|
||||
|
||||
A chat/command wRapper <sup>get it?</sup>
|
||||
|
||||
An example of this might be setting up an alias for `/wb` that simply makes the player say `Welcome back!`
|
||||
|
||||
See [examples](#examples) for more.
|
||||
|
||||
> All aliases are processed **before** registered commands.
|
||||
This means if you make an alias for an existing command, that command will no longer work directly.
|
||||
To get around that, you can still use the registered command via its namespace.
|
||||
e.g. `/essentials:ban`
|
||||
|
||||
[Example config](src/main/resources/config.yml)
|
||||
|
||||
## Commands
|
||||
|
||||
|Command|Description|
|
||||
|:---|:---|
|
||||
|`/alias <alias> <message>`|Create a chat alias.|
|
||||
|`//alias <alias> <command>`|Create a command alias.|
|
||||
|`/mixtape list [<player>]`|List aliases. If a player has the `mixtape.list.other` permission, they can view other player's aliases as well.|
|
||||
|`/mixtape delete <alias>`|Delete an alias.|
|
||||
|`/mixtape reload`|Reload Mixtape.|
|
||||
|
||||
## Permissions
|
||||
|
||||
|Permission|Description|
|
||||
|:---|:---|
|
||||
|`mixtape.admin`|Allows use of Mixtape admin commands, namely `/mixtape reload`.|
|
||||
|`mixtape.list`|Allows a player to list their aliases.|
|
||||
|`mixtape.list.other`|Allows a player to list other player's aliases.|
|
||||
|`mixtape.list.*`|Wildcard permission for the two above nodes.|
|
||||
|`mixtape.limit.x`|Give a player a specific limit (`x`) for creating aliases. Overrides the global limit.|
|
||||
|`mixtape.alias.chat`|Allows players to create chat aliases.|
|
||||
|`mixtape.alias.command`|Allows players to create command aliases.|
|
||||
|`mixtape.alias.*`|Wildcard permission for the two above nodes.|
|
||||
|`mixtape.*`|Wildcard permission for all nodes.|
|
||||
|
||||
## Examples
|
||||
|
||||
### Commands
|
||||
|
||||
`//alias wife msg MrsEtzelia`
|
||||
`/wife Hey!` -> `/msg MrsEtzelia Hey!`
|
||||
|
||||
`//alias xray co rb r:<radius> b:diamond_ore,stone #preview`
|
||||
`/xray 50` -> `/co rb r:50 b:diamond_ore,stone #preview`
|
||||
|
||||
### Chat
|
||||
|
||||
`/alias wb Welcome back!`
|
||||
`/wb` -> `Welcome back!`
|
||||
|
||||
`/alias wb Welcome back, <player>!`
|
||||
`/wb Etzelia` -> `Welcome back, Etzelia!`
|
||||
|
||||
`/alias lookup /co l r:<radius> a:container`
|
||||
Player asks "How do I check for theft?"
|
||||
`/lookup 10` -> `./co l r:10 a:container`
|
||||
|
||||
## License
|
||||
|
||||
[MIT](LICENSE)
|
||||
|
|
@ -1,6 +0,0 @@
|
|||
.idea/
|
||||
*.iml
|
||||
target/
|
||||
dependency-reduced-pom.xml
|
||||
build/
|
||||
source/.doctrees/
|
||||
|
|
@ -1,20 +0,0 @@
|
|||
# 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)
|
||||
|
|
@ -1,42 +0,0 @@
|
|||
@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.
|
Before Width: | Height: | Size: 2.8 KiB |
|
|
@ -1,12 +0,0 @@
|
|||
.. include:: ../common.rst
|
||||
|
||||
.. _mixtape_changelogs:
|
||||
|
||||
Changelogs
|
||||
==========
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
v1.0 <v1.0>
|
||||
v2.0 <v2.0>
|
||||
|
|
@ -1,16 +0,0 @@
|
|||
.. include:: ../common.rst
|
||||
|
||||
.. _mixtape_v1.0:
|
||||
|
||||
Mixtape v1.0
|
||||
========
|
||||
|
||||
This changelog is only here for legacy purposes. This is Mixtape's initial working version.
|
||||
|
||||
Additions
|
||||
---------
|
||||
None
|
||||
|
||||
Bug Fixes
|
||||
---------
|
||||
None
|
||||
|
|
@ -1,14 +0,0 @@
|
|||
.. include:: ../common.rst
|
||||
|
||||
.. _mixtape_v2.0:
|
||||
|
||||
Mixtape v2.0
|
||||
========
|
||||
|
||||
Additions
|
||||
---------
|
||||
Added H2 database support!
|
||||
|
||||
Bug Fixes
|
||||
---------
|
||||
None
|
||||
|
|
@ -1,16 +0,0 @@
|
|||
.. include:: common.rst
|
||||
|
||||
.. _mixtape_commands:
|
||||
|
||||
Commands
|
||||
========
|
||||
|
||||
``/alias <alias> <message>`` - Create a chat alias.
|
||||
|
||||
``//alias <alias> <command>`` - Create a command alias.
|
||||
|
||||
``/mixtape list [<player>]`` - List aliases. If a player has the ``mixtape.list.other`` permission, they can view other player's aliases as well.
|
||||
|
||||
``/mixtape delete <alias>`` - Delete an alias
|
||||
|
||||
``/mixtape reload`` - Reload Mixtape
|
||||
|
|
@ -1,3 +0,0 @@
|
|||
.. |br| raw:: html
|
||||
|
||||
<br>
|
||||
|
|
@ -1,170 +0,0 @@
|
|||
# -*- 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 = 'Mixtape'
|
||||
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
|
||||
|
|
@ -1,36 +0,0 @@
|
|||
.. include:: common.rst
|
||||
|
||||
.. _mixtape_examples:
|
||||
|
||||
Examples
|
||||
========
|
||||
|
||||
.. note::
|
||||
Arguments are first applied to any specified arguments in the alias. Any remaining are added to the end of the alias.
|
||||
|
||||
Commands
|
||||
--------
|
||||
|
||||
``//alias wife msg MrsEtzelia`` |br|
|
||||
``/wife Hey!`` -> ``/msg MrsEtzelia Hey!``
|
||||
|
||||
``//alias xray co rb r:<radius> b:diamond_ore,stone #preview`` |br|
|
||||
``/xray 50`` -> ``/co rb r:50 b:diamond_ore,stone #preview``
|
||||
|
||||
|
||||
Chat
|
||||
----
|
||||
|
||||
``/alias wb Welcome back!`` |br|
|
||||
``/wb`` -> ``Welcome back!``
|
||||
|
||||
``/alias wb Welcome back, <player>!`` |br|
|
||||
``/wb Etzelia`` -> ``Welcome back, Etzelia!``
|
||||
|
||||
``/alias lookup /co l r:<radius> a:container`` |br|
|
||||
Player asks "How do I check for theft?" |br|
|
||||
``/lookup 10`` -> ``./co l r:10 a:container``
|
||||
|
||||
**BONUS** |br|
|
||||
``/alias when Season 4 is starting on September 1st at 8:00 AM CST!`` |br|
|
||||
``/when`` -> ``Season 4 is starting on September 1st at 8:00 AM CST!``
|
||||
|
|
@ -1,27 +0,0 @@
|
|||
.. include:: common.rst
|
||||
|
||||
Mixtape
|
||||
=======
|
||||
|
||||
The Mixtape plugin is a chat/command wRapper :superscript:`get it?` that allows players to create customized personal command/chat aliases.
|
||||
|
||||
An example of this might be setting up an alias for ``/wb`` that simply makes the player say ``Welcome back!``
|
||||
|
||||
See the :ref:`mixtape_examples` page for more.
|
||||
|
||||
.. warning::
|
||||
All aliases are processed **before** registered commands.
|
||||
This means if you make an alias for an existing command, that command will no longer work directly.
|
||||
To get around that, you can still use the registered command via its namespace.
|
||||
e.g. /essentials:ban
|
||||
|
||||
:download:`Example Config </../../src/main/resources/config.yml>`
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:titlesonly:
|
||||
|
||||
changelog/index
|
||||
commands
|
||||
permissions
|
||||
examples
|
||||
|
|
@ -1,25 +0,0 @@
|
|||
.. include:: common.rst
|
||||
|
||||
.. _mixtape_permissions:
|
||||
|
||||
Permissions
|
||||
===========
|
||||
|
||||
``mixtape.admin`` - Allows use of Mixtape admin commands, namely ``/mixtape reload``.
|
||||
|
||||
``mixtape.list`` - Allows a player to list their aliases.
|
||||
|
||||
``mixtape.list.other`` - Allows a player to list other player's aliases.
|
||||
|
||||
``mixtape.list.*`` - Wildcard permission for the two above nodes.
|
||||
|
||||
``mixtape.limit.x`` - Give a player a specific limit for creating aliases. Overrides the global limit.
|
||||
|
||||
``mixtape.alias.chat`` - Allows players to create chat aliases.
|
||||
|
||||
``mixtape.alias.command`` - Allows players to create command aliases.
|
||||
|
||||
``mixtape.alias.*`` - Wildcard permission for the two above nodes.
|
||||
|
||||
``mixtape.*`` - Wildcard permission for all nodes.
|
||||
|
||||
9
pom.xml
9
pom.xml
|
|
@ -15,7 +15,6 @@
|
|||
<properties>
|
||||
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
|
||||
</properties>
|
||||
<url>www.etztech.xyz</url>
|
||||
|
||||
<build>
|
||||
<defaultGoal>clean package</defaultGoal>
|
||||
|
|
@ -61,8 +60,8 @@
|
|||
<url>https://oss.sonatype.org/content/groups/public/</url>
|
||||
</repository>
|
||||
<repository>
|
||||
<id>etztech-repo</id>
|
||||
<url>http://repo.etztech.xyz</url>
|
||||
<id>canopy-repo</id>
|
||||
<url>https://mvn.canopymc.net/</url>
|
||||
</repository>
|
||||
</repositories>
|
||||
|
||||
|
|
@ -75,8 +74,8 @@
|
|||
</dependency>
|
||||
<dependency>
|
||||
<groupId>xyz.etztech</groupId>
|
||||
<artifactId>EtzCore</artifactId>
|
||||
<version>1.0.5</version>
|
||||
<artifactId>plugin-api</artifactId>
|
||||
<version>1.0.7</version>
|
||||
</dependency>
|
||||
|
||||
</dependencies>
|
||||
|
|
|
|||
Loading…
Reference in New Issue