Upstream/MobArena
1
0
Fork 0
mirror of https://github.com/garbagemule/MobArena.git synced 2024-11-23 02:55:46 +01:00
Code Issues Projects Releases Wiki Activity

Update announcements documentation (see full commit)

Browse Source 
This commit does the following:

* Uses ReStructuredText style guide for the announcements documentation
* Uses active voice / minor edits
* Adds examples

This was tested locally in a development environment.
This commit is contained in:
Justin W. Flory 2017-12-02 18:57:37 -05:00 committed by garbagemule
parent e4a0783258
commit f30e6ba974
1 changed files with 58 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

75
docs/user/announcements.rst
View File

@ -2,22 +2,63 @@
Announcement strings
####################
The ``announcements.yml`` file is where all of MobArena's announcements
and messages are stored. You can freely edit this file however you see
fit, and color codes are supported. **To add color to a message**, use
the ``&``-character followed by a valid color code. You can find a list
of valid codes `right
here <http://minecraft.gamepedia.com/Formatting_codes#Color_codes>`__,
and you can find examples in the default file.
MobArena supports custom strings for announcement and messages. This lets you
create custom messages unique to your server based on certain actions, like a
game ending. The ``announcements.yml`` file stores MobArena announcement and
message strings. [#]_
Note that some of the announcements take a variable, represented in the
message by a ``%``-character. You can leave this character out if you
don't want the variable in the message. It is not possible to add
variables to announcements that don't take them by default, and
announcements that take one variable cannot take more than that one
variable.
.. [#] Default strings are found in the `Msg.java`_ class
If you **don't want to see a specific announcement**, you have to set
its value to ``''`` (note: two single-quotes, not one double-quote).
This will cause MobArena to ignore the announcement. Note that simply
removing the node will not work, as MobArena forcefully adds it back in.
*************
Color support
*************
Color codes are supported. **To add color to a message**, use an ampersand
(``&``) followed by a valid color code. `Color codes`_ are available in the
Gamepedia Minecraft wiki. Examples are in the default file.
*********
Variables
*********
Some announcements use a variable. In the string, variables are represented by a
percent sign (``%``). Remove it if you do not want a variable in the message.
There are some limitations to variables:
- Not possible to add variables to announcements that don't take them by default
- Announcements that take one variable cannot take more than that variable
***********************
Disable an announcement
***********************
If you want to **disable a specific announcement**, set its value to two single
quotes (``''``). MobArena ignores announcements set to an empty value. To
disable one, you must override it. Deleting the option does not disable an
announcement since MobArena adds them in by default.
********
Examples
********
Three examples below show all of the features explained above.
.. code-block:: yaml
:emphasize-lines: 2, 5, 8
# Use a red message for the start of a new game
arena-start: 'Let the games begin! &cMay the odds be ever in your favor!'
# Use a variable for the number of seconds until the game begins
arena-auto-start: 'Arena will auto-start in &c%&r seconds.'
# Turn off the golem-died message
golem-died: ''
.. _`Msg.java`: https://github.com/garbagemule/MobArena/blob/master/src/main/java/com/garbagemule/MobArena/Msg.java
.. _`color codes`: https://minecraft.gamepedia.com/Formatting_codes#Color_codes