From 30313d8af7e225ab300244de939759451969d8cf Mon Sep 17 00:00:00 2001 From: Matt Brockman Date: Tue, 19 Jan 2021 07:50:49 -0800 Subject: [PATCH] fix SimplePossibilityBot spelling --- README.md | 6 ++++-- examples/EvaluationBotData/README.md | 4 ++-- examples/inputBot.js | 1 + 3 files changed, 7 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 2e40013..76091b1 100644 --- a/README.md +++ b/README.md @@ -56,8 +56,10 @@ The `state` variable can be used to store information that's persistent across f * `state.displayStats` takes an array of objects [{key, value, color}] which will be displayed for users in the score section as [key]: [value] in the preferred color (defaults to user color). See https://github.com/latitudegames/Scripting/blob/master/examples/showTextLength.js for an example. * `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 evaluation 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.inputBot` uses an evaluation bot to assess the input and convert it to machine readable formats for conducting functions such as skill checks in the context. The results of the `inputBot` are returned in `info.inputEvaluation`. Different bots return a `reason` (description of their interpretation of the text) as well as various assessment such as `DC` or `skill`. See https://github.com/latitudegames/Scripting/blob/master/examples/inputBot.js for usage and available bots. +* Evaluation Bots: + * See https://github.com/latitudegames/Scripting/tree/master/examples/EvaluationBotData for specific bot information. + * `state.evaluationBot` uses an evaluation 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.inputBot` uses an evaluation bot to assess the input and convert it to machine readable formats for conducting functions such as skill checks in the context. The results of the `inputBot` are returned in `info.inputEvaluation`. Different bots return a `reason` (description of their interpretation of the text) as well as various assessment such as `DC` or `skill`. See https://github.com/latitudegames/Scripting/blob/master/examples/inputBot.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. diff --git a/examples/EvaluationBotData/README.md b/examples/EvaluationBotData/README.md index c26efb0..3e22299 100644 --- a/examples/EvaluationBotData/README.md +++ b/examples/EvaluationBotData/README.md @@ -6,8 +6,8 @@ Bots and their usage - `InputDCattributeBot` - Evaluate the attribute and difficulty of an action (returns numeric difficulty) # Input Special Usage -- `SimplePossiblityBot` - Evalutes two possible actions, PossibleAction1 and PossibleAction2. - - Special Usage: When `state.inputBot='SimplePossiblityBot'` you need to provide a character description in `state.contextualString`. This can be up to 75 characters (additional length will be truncated). `SimplePossiblityBot` will use the character description with the actions to provide information on what the character can do in the situation. Useful for enforcing limitations such as missing limbs or weapons. +- `SimplePossibilityBot` - Evalutes two possible actions, PossibleAction1 and PossibleAction2. + - Special Usage: When `state.inputBot='SimplePossibilityBot'` you need to provide a character description in `state.contextualString`. This can be up to 75 characters (additional length will be truncated). `SimplePossiblityBot` will use the character description with the actions to provide information on what the character can do in the situation. Useful for enforcing limitations such as missing limbs or weapons. # Output The following bots are best used on output. diff --git a/examples/inputBot.js b/examples/inputBot.js index 8b1b8d8..20c8c32 100644 --- a/examples/inputBot.js +++ b/examples/inputBot.js @@ -27,4 +27,5 @@ modifier(text) AVAILABLE BOTS ['DCStatDifficultyBot'] - Stat, Difficulty ['InputDCattributeBot'] - DC, Attrbute +['SimplePossibilityBot'] - Possibility 1, Possibility 2 */ \ No newline at end of file