update docs

botisimo · Sep 17, 2021 · 801c133 · 801c133
1 parent 0c21e21
commit 801c133
Show file tree

Hide file tree

Showing 5 changed files with 51 additions and 2 deletions.
diff --git a/docs/directives/cost.rst b/docs/directives/cost.rst
@@ -1,13 +1,14 @@
 $[cost]
 =======
 
-Directs the bot to add a currency cost to the command.
+Directs the bot to deduct currency from the user who uses the command or optionally the targeted user.
 
 Usage:
-    $[cost ``<amount>``]
+    $[cost ``<amount>`` ``[user]``]
 
 Arguments:
     * ``amount`` **<required>** - Amount of currency it should cost
+    * ``user`` **[optional]** - The user to deduct from the currency (if no user then it will deduct from the user issuing the command)
 
 Example Command:
     **name**: !cost
@@ -20,3 +21,13 @@ Example Command:
         botisimo: You just paid 50 Goldfrags to use this command, ha!
         user:     !cost
         botisimo: Not enough Goldfrags to use that command 37/50
+
+Example Command:
+    **name**: !cost
+
+    **response**: $[cost 50 $(1)] $(1) just lost 50 Goldfrags, ha!
+
+    **output**::
+
+        user:     !cost @username
+        botisimo: @username just lost 50 Goldfrags, wooha!
diff --git a/docs/sponsorship/index.rst b/docs/sponsorship/index.rst
@@ -36,3 +36,5 @@ Related Videos
 ^^^^^^^^^^^^^^
 
 .. youtube:: FSYnSIEPl_k
+
+.. youtube:: ywibhnjDYhs
diff --git a/docs/variables/index.rst b/docs/variables/index.rst
@@ -52,5 +52,7 @@ Response variables are used to make dynamic `custom command <https://botisimo.co
    usertype
    winner
    xp
+   xpnext
+   xpcurrent
    youtube
    advanced
diff --git a/docs/variables/xpcurrent.rst b/docs/variables/xpcurrent.rst
@@ -0,0 +1,17 @@
+$(xpcurrent)
+============
+
+Resolves the amount of xp currently gained towards next level.
+
+Usage:
+    $(xpcurrent)
+
+Example Command:
+    **name**: !xpcurrent
+
+    **response**: You have $(xpcurrent) XP towards next level
+
+    **output**::
+
+        user:     !xpcurrent
+        botisimo: You have 5,000 XP towards next level
diff --git a/docs/variables/xpnext.rst b/docs/variables/xpnext.rst
@@ -0,0 +1,17 @@
+$(xpnext)
+=========
+
+Resolves the amount of xp needed to reach next level.
+
+Usage:
+    $(xpnext)
+
+Example Command:
+    **name**: !xpnext
+
+    **response**: You have $(xpnext) XP until next level
+
+    **output**::
+
+        user:     !xpnext
+        botisimo: You have 5,000 XP until next level