archives/AIDScripting
Archived
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

fix SimplePossibilityBot spelling

Browse source
This commit is contained in:
Matt Brockman 2021-01-19 07:50:49 -08:00
parent d9c2fdddce
commit 30313d8af7
3 changed files with 7 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
README.md
View file

@ -56,6 +56,8 @@ 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.
* 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:

4
examples/EvaluationBotData/README.md
View file

@ -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.

1
examples/inputBot.js
View file

@ -27,4 +27,5 @@ modifier(text)
AVAILABLE BOTS
['DCStatDifficultyBot'] - Stat, Difficulty
['InputDCattributeBot'] - DC, Attrbute
['SimplePossibilityBot'] - Possibility 1, Possibility 2
*/