From 54a6a900d33972532e0939d6eec4e77adcf41db9 Mon Sep 17 00:00:00 2001 From: "Ean Milligan (Bastion)" Date: Tue, 17 May 2022 00:39:38 -0400 Subject: [PATCH] Add roll formatting documentation to readme --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 7f6c370..228b6e9 100644 --- a/README.md +++ b/README.md @@ -95,6 +95,10 @@ The Artificer comes with a few supplemental commands to the main rolling command * `-n` - Nominal Roll - Rolls the theoretical nominal roll, cannot be used with -m * `-gm @user1 @user2 ... @usern` - GM Roll - Rolls the requested roll in GM mode, suppressing all publicly shown results and details and sending the results directly to the specified GMs * `-o a` or `-o d` - Order Roll - Rolls the requested roll and orders the results in the requested direction + * The results have some formatting applied on them to provide details on what happened during this roll. + * Critical successes will be **bolded** + * Critical fails will be underlined + * Rolls that were dropped or rerolled ~~crossed out~~ ## The Artificer API The Artificer features an API that allows authenticated users to roll dice into Discord from third party applications (such as Excel macros). The API has a couple endpoints exposed to all authenticated users allowing management of channels that your API key can send rolls to. APIs requiring administrative access are not listed below.