From 090ce9be457db9d765f398e990710165c8e22404 Mon Sep 17 00:00:00 2001
From: projectmoon <projectmoon@noreply.git.agnos.is>
Date: Mon, 3 Apr 2023 22:01:17 +0200
Subject: [PATCH] Add help topic for variables

Fixes #60
---
 Cargo.lock          |  2 +-
 dicebot/Cargo.toml  |  2 +-
 dicebot/src/help.rs | 33 +++++++++++++++++++++++++++++++++
 3 files changed, 35 insertions(+), 2 deletions(-)

diff --git a/Cargo.lock b/Cargo.lock
index de819ae..eade8dc 100644
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -3190,7 +3190,7 @@ dependencies = [
 
 [[package]]
 name = "tenebrous-dicebot"
-version = "0.13.1"
+version = "0.13.2"
 dependencies = [
  "async-trait",
  "barrel",
diff --git a/dicebot/Cargo.toml b/dicebot/Cargo.toml
index c3cc641..3f8bdee 100644
--- a/dicebot/Cargo.toml
+++ b/dicebot/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "tenebrous-dicebot"
-version = "0.13.1"
+version = "0.13.2"
 rust-version = "1.68"
 authors = ["projectmoon <projectmoon@agnos.is>", "Taylor C. Richberger <taywee@gmx.com>"]
 edition = "2018"
diff --git a/dicebot/src/help.rs b/dicebot/src/help.rs
index 7eeebf5..9f131ac 100644
--- a/dicebot/src/help.rs
+++ b/dicebot/src/help.rs
@@ -6,6 +6,9 @@ pub fn parse_help_topic(input: &str) -> Option<HelpTopic> {
         "dicepool" => Some(HelpTopic::DicePool),
         "dice" => Some(HelpTopic::RollingDice),
         "cthulhu" => Some(HelpTopic::Cthulhu),
+        "variables" => Some(HelpTopic::Variables),
+        "var" => Some(HelpTopic::Variables),
+        "variable" => Some(HelpTopic::Variables),
         "" => Some(HelpTopic::General),
         _ => None,
     }
@@ -16,6 +19,7 @@ pub enum HelpTopic {
     DicePool,
     Cthulhu,
     RollingDice,
+    Variables,
     General,
 }
 
@@ -101,6 +105,34 @@ Note: If !cthadv is given a variable, and the roll is successful, it will
 update the variable with the new skill.
 "};
 
+const VARIABLES_HELP: &'static str = indoc! {"
+Variables
+
+Commands: !get, !set, !variables
+
+Manage variables that can be substituted into roll commands.
+
+Examples: !get myvar, !set myvar 10
+
+!get <variable> = show variable of the given name
+!set <variable> <num> = set a variable to a number
+
+The !variables command will list all variables for the room. The
+variables command cna be used in a secure room to avoid spamming the
+actual room that the variable is set in.
+
+Variable names can be used in all types of dice rolls:
+
+!pool myvar + 3
+!roll myvar
+
+There are some limitations on variables: they cannot themselves be
+dice expressions (i.e. can only be numbers), and they must be uniquely
+parseable in an expression (i.e 'myvard6' does not work for the !roll
+command).
+
+"};
+
 const GENERAL_HELP: &'static str = indoc! {"
 General Help
 
@@ -117,6 +149,7 @@ impl HelpTopic {
             HelpTopic::DicePool => DICEPOOL_HELP,
             HelpTopic::Cthulhu => CTHULHU_HELP,
             HelpTopic::RollingDice => DICE_HELP,
+            HelpTopic::Variables => VARIABLES_HELP,
             HelpTopic::General => GENERAL_HELP,
         }
     }