diff --git a/README.md b/README.md index 76091b1..c82532a 100644 --- a/README.md +++ b/README.md @@ -56,10 +56,6 @@ 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: * `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 deleted file mode 100644 index 5cc80b5..0000000 --- a/examples/EvaluationBotData/README.md +++ /dev/null @@ -1,30 +0,0 @@ -# Evaluation Bots -Bots and their usage - -# Input -- `DCStatDifficultyBot` - Evaluates the stat required and difficulty of an action (returns hard/medium/easy difficulty) -- `InputDCattributeBot` - Evaluate the attribute and difficulty of an action (returns numeric difficulty) - -# Input Special Usage -- `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. - -## Multipurpose Evaluation Bots - -- `GoblinBot` - Evaluates whether it detected any Goblins killed, health was lost, and loot gained -- `KittenBot` - Evaluates whether rapport was gained or a kitten got hungrier -- `SpaceLootBot` - Evaluates whether loot would be found (on a spaceship) -- `HungerBot` - Evaluates whether the player would get hungrier or not -- `RestDetectBot` - Evaluates whether or not the user got rest - -## Simple Evaluation Bots -There are several evaluation score bots. These bots can be used on either input or output to score different text. They all return a `reason` and a `score` which is roughly along the below descriptions. -- `KillBot` - Evaluates whether the player is killing things -- `JudgeBot` - Evaluates whether an action was just -- `EmpathyBot` - Evaluates whether an action showed empathy -- `SuccessBot` - Evaluates whether an action succeeded -- `SantaBot` - Evaluates whether an action showed christmas spirit (An overly judgemental SantaBot also exists but is not currently available) - diff --git a/examples/evaluationBots.js b/examples/evaluationBots.js deleted file mode 100644 index b9fa1b4..0000000 --- a/examples/evaluationBots.js +++ /dev/null @@ -1,35 +0,0 @@ - -// Checkout the repo examples to get an idea of other ways you can use scripting -// https://github.com/latitudegames/Scripting/blob/master/examples - -//CONTEXT MODIFIER -const modifier = (text) => { - state.evaluationBot = 'JudgeBot' -return { text } -} - -// Don't modify this part -modifier(text) - - -// OUTPUT MODIFIER -const modifier = (text) => { - console.log(info) -return { text } -} - -// Don't modify this part -modifier(text) - - - -/* - AVAILABLE BOTS -['KillBot', 'JudgeBot', 'EmpathyBot', 'SuccessBot', 'SantaBot'] -> Score -['GoblinBot'] -> Goblins killed, health lost, loot gained -['KittenBot'] -> Rapport gained, hunger -['SpaceLootBot'] -> Loot -['DCStatDifficultyBot'] -> Stat, Difficulty -['HungerBot'] -> Fullness -['SimplePossiblityBot'] -> PossibleAction1, PossibleAction2 -*/ \ No newline at end of file diff --git a/examples/inputBot.js b/examples/inputBot.js deleted file mode 100644 index e117516..0000000 --- a/examples/inputBot.js +++ /dev/null @@ -1,22 +0,0 @@ - -// Checkout the repo examples to get an idea of other ways you can use scripting -// https://github.com/latitudegames/Scripting/blob/master/examples - -//INPUT MODIFIER -const modifier = (text) => { - state.inputBot = 'DCStatDifficultyBot' -return { text } -} - -// Don't modify this part -modifier(text) - - -// CONTEXT MODIFIEr -const modifier = (text) => { - console.log(info?.inputEvaluation) -return { text } -} - -// Don't modify this part -modifier(text) \ No newline at end of file