From e3d6d5e3a453864ef7567044ab26b9f9a038bb7a Mon Sep 17 00:00:00 2001 From: Paradox <25272926+Parazoid@users.noreply.github.com> Date: Mon, 23 Dec 2019 01:07:26 +0100 Subject: [PATCH] add flash and screenshake documentation Updated README to document the screenshake and flash in-character markup options. --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 0416e4a..5d8e2c6 100644 --- a/README.md +++ b/README.md @@ -100,6 +100,14 @@ If you begin a message with `~~` (two tildes), the two tildes are removed and th If two players are in the same position and select each other's characters using the in-game pair list (or with `/pair [id]`), they will appear alongside each other. You can set the offset of your character using the provided spinbox (or with `/offset [percentage]`). +### Screenflash (2.6+) + +Placing a `$` (dollar symbol) at any point in the message will cause a white flash to appear at that point, and the symbol will disappear. You can do this multiple times in one message and stack it up with any other markup symbol. The flash will be silent, unlike the equivalent button. + +### Screenshake (2.6+) + +Placing an `@` (at symbol) at any point in the message will cause the screen to shake at that point, and the symbol will disappear. You can do this multiple times in one message and stack it up with any other markup symbol (including the screenflash). + ### Non-interrupting preanimations (2.6+) When checked, this will force text to immediately begin displaying without waiting for the preanimation to finish.