From 236a2aa5dc51d7da286cf8210668904321a8af3a Mon Sep 17 00:00:00 2001
From: Matt Brockman <mattbrockman@gmail.com>
Date: Fri, 15 Jan 2021 20:44:31 -0800
Subject: [PATCH] explain current skills setup

---
 README.md          |  4 ++++
 examples/skills.js | 33 +++++++++++++++++++++++++++++++++
 2 files changed, 37 insertions(+)
 create mode 100644 examples/skills.js

diff --git a/README.md b/README.md
index e3a3b4a..11d46f1 100644
--- a/README.md
+++ b/README.md
@@ -57,6 +57,10 @@ The `state` variable can be used to store information that's persistent across f
 * `state.inventory` takes an array of objects [{name, quantity}] which will be make the inventory option available in the adventure menu (right). For now, this just displays all items and thier quantities from the inventory.
 See https://github.com/latitudegames/Scripting/blob/master/examples/addSimpleInventory.js for an example.
 * `state.evaluationBot` uses an evlation bot to assess latest actions and convert it to machine readable formats. The results of the `evaluationBot` are returned in `info.evaluation`. Different bots return a `reason` (description of their interpretation of the text) as well as various assessment such as `loot` or `health`. See https://github.com/latitudegames/Scripting/blob/master/examples/evaluationBots.js for usage and available bots.
+* `state.skills` is a dictionary {...values, skill(str):level(int)}. A value in state.skills will enable the skills overlay in the adventure menu. The skills overlay allows players to allocate `skillPoints` or learn `random skills` which can be set with the following parameters:
+  * `state.disableRandomSkill` disables the user from learning random skills in the screen
+  * `state.skillPoints` sets the number of skill points a player has available.
+
 
 * You can set any variable on state to store and modify adventures throughout an adventure.
 
diff --git a/examples/skills.js b/examples/skills.js
new file mode 100644
index 0000000..31c4ba6
--- /dev/null
+++ b/examples/skills.js
@@ -0,0 +1,33 @@
+//input modifiers to set up skills
+
+
+//EXAMPLE 1
+//creates skills with 0 skill points
+const modifier = (text) => {    
+    state.skills = {'turtle':1}
+  }
+  
+  // Don't modify this part
+  modifier(text)
+  
+//EXAMPLE 2
+//creates skills with 1 skill point
+const modifier = (text) => {    
+    state.skills = {'turtle':1}
+    state.skillPoints = 1
+  }
+  
+  // Don't modify this part
+  modifier(text)
+  
+//EXAMPLE 3
+//creates skills with 5 skill points and 
+const modifier = (text) => {    
+    state.skills = {'turtle':1}
+    state.skillPoints = 1
+    state.disableRandomSkill = true
+  }
+  
+  // Don't modify this part
+  modifier(text)
+  
\ No newline at end of file