From ed3c25df3174bfc03db6322ae52a397ce2fed836 Mon Sep 17 00:00:00 2001 From: Mara Date: Mon, 9 Dec 2024 19:57:37 +0100 Subject: [PATCH] feat(docs): add detailed section on criticals in admin model docs --- .../current/admin/model/index.md | 34 ++++++++++++++++++- 1 file changed, 33 insertions(+), 1 deletion(-) diff --git a/en/docusaurus-plugin-content-docs/current/admin/model/index.md b/en/docusaurus-plugin-content-docs/current/admin/model/index.md index 7963350..789ab60 100644 --- a/en/docusaurus-plugin-content-docs/current/admin/model/index.md +++ b/en/docusaurus-plugin-content-docs/current/admin/model/index.md @@ -82,6 +82,38 @@ Statistics are based on a name, but you will notice that after generating the fi ``` +## Criticals + +It is possible to define: +- **Basic Critical**, which are tied to natural dice rolls and can be configured as critical successes or critical failures. +- **Custom Critical**, which can apply to natural dice rolls or total results. + +In both cases, critical are only active with the `/dbroll` command and allow a special message to be displayed depending on the result. + +### Basic Critical + +These can only be tied to an equality with the natural die roll. The value is configurable, but the displayed message is not. +Thus, in the case where: +- You achieve a critical success value, the displayed message will be: `Critical Success` +- Similarly, for a critical failure, the displayed message will be: `Critical Failure` + +The messages can be overridden by **Custom Critical**. + +### Custom Critical + +Custom critical allow you to define a value for which a personalized message will be displayed. Unlike basic criticals, custom criticals can compare against either a total **or** a natural die roll, and they support formulas. +You can create up to 22 custom critical in total. + +This enables, for example, critical linked to a statistic value using `$`, as in comparisons with dice types. + +:::example [Call of Cthulhu] +*Reference*: [Call of Cthulhu RPG Wiki](https://cthulhuwiki.chaosium.com/rules/combat.html) +In the case of Call of Cthulhu, success is based on the value of a statistic. The die type would then be `1D100<=$`. +Custom critical could be defined as: +- **"Hard success"**: `<=round($/2)` +- **"Extreme success"**: `<=round($/5)` +::: + ## What's Next? Once the template is ready, use `/register [#channel] [file] (#user_chan) (#private_character)`. @@ -102,4 +134,4 @@ You need to re-register the template if you want to change the default channel f If you need to move all the sheets to another channel, you need to use the [`/export`](../config/import_export.md) command. ::: -[^1]: It is possible to use a forum, which will automatically create a post for the character. The player (and administrators) will be mentioned in the post. \ No newline at end of file +[^1]: It is possible to use a forum, which will automatically create a post for the character. The player (and administrators) will be mentioned in the post.