docs: Add new variables for dynamic chat messages & commands

Author: styler

docs/chatbot/variables/game.md

@@ -1,29 +1,42 @@
 ---
 id: game
-sidebar_label: $(game)
+sidebar_label: "$(game)"
+description: "Learn how to use the $(game) variable to display the current game being played on a Twitch channel."
+tags:
+- variables
+- game
+- twitch
+keywords:
+- StreamElements
+- chatbot
+- game variable
+- Twitch game
+- stream information
 ---
 
-# Game Variable
+# $(game) Variable
 
-### Description
+## Overview
 
-The `$(game)` variable displays the current game being played on a Twitch channel.
+The `$(game)` variable is a powerful tool that allows you to display the current game being played on a Twitch channel. This variable is particularly useful for creating dynamic commands or messages that reference the streamer's current activity.
 
-### Usage
+## Usage
+
+To use the `$(game)` variable, simply include it in your command or message:
 
 ```
 $(game)
 ```
 
-You can also specify a username to check the game of a different channel:
+You can also check the game of a specific channel by providing a username:
 
 ```
 $(game *username*)
 ```
 
-### Examples
+## Examples
 
-1. Check the current game on your channel:
+1. Display the current game on your channel:
    ```
    Current game: $(game)
    ```
@@ -35,12 +48,22 @@ $(game *username*)
    ```
    Output: `shroud is playing: Counter-Strike: Global Offensive`
 
-### Parameters
+## Parameters
 
 - `username` (optional): The Twitch username of the channel you want to check. If not provided, the command will display the game of the current channel.
 
-### Related Commands/Variables
+## Related Commands
 
 - [`$(title)`](title.md): Displays the current stream title
 - [`$(channel)`](channel.md): Shows information about the current channel
 - [`$(uptime)`](uptime.md): Displays how long the current stream has been live
+
+## FAQ
+
+**Q: How often does the game information update?**
+
+A: The game information typically updates within a few seconds of changing the game on Twitch. However, the exact timing may vary.
+
+**Q: What happens if no game is set?**
+
+A: If no game is set for the channel, the `$(game)` variable will typically return "No game set" or a similar message.

docs/chatbot/variables/getcount.md

@@ -1,26 +1,66 @@
 ---
 id: getcount
+sidebar_label: "$(getcount)"
+description: "Learn how to use the $(getcount) variable in StreamElements Chatbot to retrieve counter values without incrementing them."
 tags:
   - chatbot
   - variable
+  - counter
+keywords:
+  - StreamElements
+  - chatbot
+  - counter
+  - variable
+  - streaming
 ---
 
 # $(getcount)
 
-Returns the current value of a counter without incrementing it.
+## Overview
 
-#### Parameters
+The `$(getcount)` variable allows you to retrieve the current value of a counter without incrementing it. This is useful for displaying counter values in chat messages or on stream overlays.
 
-This variable takes the name of the counter to get as a parameter.
+## Usage
 
-#### Example Input
+To use the `$(getcount)` variable, you need to provide the name of the counter as a parameter. The syntax is as follows:
 
 ```
-$(getcount example)
+$(getcount counterName)
 ```
 
-#### Example Output
+## Examples
+
+Here are two practical examples of how to use the `$(getcount)` variable:
+
+1. Displaying the current number of subscribers:
 
 ```
-420
+We currently have $(getcount subscribers) subscribers! Thank you for your support!
 ```
+
+2. Showing the number of times a specific command has been used:
+
+```
+The !hug command has been used $(getcount hugs) times in this stream.
+```
+
+## Parameters
+
+The `$(getcount)` variable takes one parameter:
+
+- `counterName`: The name of the counter you want to retrieve the value for. This is a required parameter.
+
+## Related Variables
+
+- [`$(count)`](count.md): Increments a counter and returns its new value
+
+## FAQ
+
+**Q: Can I use $(getcount) to create a new counter?**
+A: No, `$(getcount)` only retrieves existing counter values. To create a new counter, use the `$(count)` variable first.
+
+**Q: What happens if I try to get the count of a non-existent counter?**
+A: If the counter doesn't exist, `$(getcount)` will return 0.
+
+**Q: Is there a limit to how many counters I can have?**
+A: StreamElements doesn't specify a limit, but it's good practice to use counters judiciously to avoid performance issues.

docs/chatbot/variables/leagueoflegends.md

@@ -1,35 +1,56 @@
 ---
 id: leagueoflegends
+sidebar_label: "$(leagueoflegends)"
+description: "Get a League of Legends player's rank and LP using StreamElements Chatbot. Supports Riot IDs and multiple regions."
 tags:
   - chatbot
   - variable
   - League of Legends
-description: Outputs the summoner rank and LP of a specified League of Legends player
 keywords:
   - streamelements lol rank command
   - league of legends command
+  - riot id rank lookup
+  - summoner rank checker
 ---
 
-# $(leagueoflegends)
+# $(leagueoflegends) Variable
 
-Outputs the summoner rank and LP of a specified League of Legends player.
+## Overview
 
-:::info Riot IDs
-League of legends is transitioning to Riot IDs. This means that you will need to use your Riot ID instead of your summoner name.
+The `$(leagueoflegends)` variable allows you to retrieve and display the current rank and LP (League Points) of a specified League of Legends player using the StreamElements Chatbot.
+
+## Usage
+
+To use this variable, you need to provide two parameters: the region and the player's Riot ID or Summoner Name.
+
+```
+$(leagueoflegends <region> <Riot ID/Summoner Name>)
+```
 
-During the transition period, you can use either your Riot ID or your summoner name. After the transition period, you will only be able to use your Riot ID.
+:::info Riot IDs
+League of Legends is transitioning to Riot IDs. During the transition, you can use either Riot IDs or Summoner Names. After the transition, only Riot IDs will be supported.
 :::
 
-#### Parameters
+**Note:** If the Riot ID contains spaces, wrap it in quotes.
+
+## Examples
+
+```
+$(leagueoflegends euw styler#euw)
+$(leagueoflegends na "Doublelift#na1")
+```
 
-This variable takes two parameters:
+Example output:
+```
+Current Rank: Challenger I (1229 LP)
+```
 
-1. Region
-2. Riot ID/Summoner Name
+## Parameters
 
-**NOTE:** If your Riot ID contains one or more spaces, you will need to wrap it in quotes.
+1. **Region**: The server region of the player (e.g., `euw`, `na`)
+2. **Riot ID/Summoner Name**: The player's unique identifier
 
-#### Supported Regions
+## Supported Regions
 
 - `br` (Brazil)
 - `eune` (Europe Nordic & East)
@@ -49,15 +70,8 @@ This variable takes two parameters:
 - `tr` (Turkey)
 - `vn` (Vietnam)
 
-#### Example Input
-
-```
-$(leagueoflegends styler#euw euw)
-$(leagueoflegends "styler#euw" euw)
-```
+## FAQ
 
-#### Example Output
+**Q: Why isn't the rank updating immediately?**
 
-```
-Current Rank: Challenger I (1229 LP)
-```
+A: Rank data may have a slight delay due to API caching. It typically updates within a few minutes after a player's ranked game.

docs/chatbot/variables/math.md

@@ -1,30 +1,78 @@
 ---
 id: math
+sidebar_label: "$(math)"
+description: "Learn how to use the $(math) variable in StreamElements Chatbot for performing mathematical calculations in chat messages."
 tags:
   - chatbot
   - variable
+  - math
+keywords:
+  - StreamElements
+  - chatbot
+  - math
+  - calculations
+  - expressions
 ---
 
-# $(math)
+# $(math) Variable
 
-Outputs the result of a math.js expression.
+## Overview
 
-#### Parameters
+The `$(math)` variable allows you to perform mathematical calculations and operations directly in your StreamElements Chatbot messages. It utilizes the math.js library, providing a wide range of mathematical functions and capabilities.
 
-This variable takes a math.js expression as a parameter. You can also use math.js functions like `round()`, `floor()`, `log()`, `random()`, etc. 
+## Usage
 
-#### Example Input
+To use the `$(math)` variable, include it in your message followed by a valid math.js expression:
 
 ```
-${math 2 + 2}
-${math round(10/3)}
-${math random(1,10)}
+$(math *expression*)
 ```
 
-#### Example Output
+Replace *expression* with the mathematical operation you want to perform.
 
-```
-4
-3
-7.525986609745358
-```
+## Examples
+
+Here are some practical examples of how to use the `$(math)` variable:
+
+1. Basic arithmetic:
+   ```
+   Bot: 2 + 2 equals $(math "2 + 2")
+   Output: 2 + 2 equals 4
+   ```
+
+2. Rounding a division result:
+   ```
+   Bot: 10 divided by 3, rounded to the nearest integer, is $(math "round(10/3)")
+   Output: 10 divided by 3, rounded to the nearest integer, is 3
+   ```
+
+3. Generating a random number:
+   ```
+   Bot: Your random number between 1 and 10 is $(math "random(1,10)")
+   Output: Your random number between 1 and 10 is 7.525986609745358
+   ```
+
+## Parameters
+
+The `$(math)` variable takes a single parameter: a valid math.js expression. This can include:
+
+- Basic arithmetic operations (`+`, `-`, `*`, `/`)
+- Mathematical functions (e.g., `round()`, `floor()`, `ceil()`, `log()`, `sin()`, `cos()`)
+- Constants (e.g., `pi`, `e`)
+- Logical operators (e.g., `>`, `<`, `==`, `!=`)
+
+For a complete list of supported operations and functions, refer to the [math.js documentation](https://mathjs.org/docs/index.html).
+
+## Related Variables
+
+- [`$(customapi)`](customapi.md): Can be used to fetch and process numerical data from external sources
+
+## FAQ
+
+**Q: Can I use variables in my math expressions?**
+
+A: Yes, you can use other StreamElements variables within your `$(math)` expression. For example: `$(math "{points} * 2")` would double the user's points.
+
+**Q: Is there a limit to the complexity of expressions I can use?**
+
+A: While there's no strict limit, very complex expressions may take longer to process. It's best to keep expressions relatively simple for optimal performance.

docs/chatbot/variables/msgid.md

@@ -1,26 +1,51 @@
 ---
 id: msgid
+sidebar_label: "$(msgid)"
+description: "Learn how to use the $(msgid) variable to retrieve unique message IDs in StreamElements Chatbot commands."
 tags:
   - chatbot
   - variable
+  - message id
+keywords:
+  - StreamElements
+  - chatbot
+  - message ID
+  - command trigger
+  - unique identifier
 ---
 
-# $(msgid)
+# $(msgid) Variable
 
-Outputs the message ID of the message that triggered the command.
+## Overview
 
-#### Parameters
+The `$(msgid)` variable is a powerful tool in the StreamElements Chatbot that outputs the unique message ID of the message that triggered a command. This can be useful for tracking specific messages, debugging, or creating advanced custom functionality in your stream.
 
-This variable does not take any parameters.
+## Usage
 
-#### Example Input
+To use the `$(msgid)` variable, simply include it in your command response or custom script. The chatbot will automatically replace it with the actual message ID when the command is triggered.
 
-```
-$(msgid)
-```
+## Examples
 
-#### Example Output
+Here are two practical examples of how you might use the `$(msgid)` variable:
+
+1. Basic usage in a command response:
 
 ```
-bcc9b4bc-566d-4f14-a57d-a86c1c3196f8
+!messageid
+Bot: The ID of the message that triggered this command is: $(msgid)
 ```
+
+## Parameters
+
+The `$(msgid)` variable does not accept any parameters. It simply returns the message ID of the triggering message.
+
+## Related Commands
+
+- [`$(user)`](user.md): Returns the username of the person who triggered the command
+- [`$(channel)`](channel.md): Returns the name of the channel where the command was triggered
+
+## FAQ
+
+**Q: What format does the message ID use?**
+
+A: The message ID is typically a UUID (Universally Unique Identifier) in the format of a string of letters and numbers separated by hyphens, such as `bcc9b4bc-566d-4f14-a57d-a86c1c3196f8`.