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

Update README.md

Browse source
This commit is contained in:
Andrew Cantino 2020-09-27 13:03:38 -07:00 • committed by GitHub
parent c2b7685b48
commit 431274bdc7
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 6 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
README.md
View file

@ -11,7 +11,7 @@ Then now's a great time to learn! A good resource to learn javascript from scrat
https://www.codecademy.com/courses/introduction-to-javascript https://www.codecademy.com/courses/introduction-to-javascript
## History ## History
You have access to (but can't modify) the `history` object which is a list of the previous actions of the player and of the AI including the action type. You have access to (but can't modify) the `history` object which is a list of the previous actions of the player and of the AI, including the action type.
## Memory ## Memory
You have access to (but can't modify) the `memory` object which is the current user defined memory. You have access to (but can't modify) the `memory` object which is the current user defined memory.
@ -24,8 +24,9 @@ You can set `state.memory.authorsNote` to provide a piece of text that will alwa
As an example, if you set `state.memory.authorsNote` to `the following paragraphs are scary.`, the AI will see `[Author's note: the following paragraphs are scary.]` three lines back, causing it to be more likely to generate scary text. Another example could be `a dragon will show up soon` or `the player will soon receive a quest`. As an example, if you set `state.memory.authorsNote` to `the following paragraphs are scary.`, the AI will see `[Author's note: the following paragraphs are scary.]` three lines back, causing it to be more likely to generate scary text. Another example could be `a dragon will show up soon` or `the player will soon receive a quest`.
## Modifiers ## Modifiers
### Shared Library ### Shared Library
Appended to the start of the other three scripts so you can use the same code between all three. Prepended to the start of the other three scripts before execution so that you can share code between all three.
### Input Modifier ### Input Modifier
Called each time the player gives an input and has the opportunity to modify that input. Called each time the player gives an input and has the opportunity to modify that input.
@ -54,9 +55,11 @@ The `state` variable can be used to store information that's persistent across f
`console.log("Some message")` will log messages that you can see in the scripting console `console.log("Some message")` will log messages that you can see in the scripting console
## Info ## Info
`info` contains some useful values, depending on which modifier you're in. `info` contains some useful values, depending on which modifier you're in.
All modifiers have access to `info.actionCount`, the number of actions in the adventure so far. All modifiers have access to `info.actionCount`, the number of actions in the adventure so far.
When in a Context Modifier, `info.memoryLength` and `info.maxChars` are also set, indicating the length of the memory portion of text (if any), and the total allowed length of the context after which it will be truncated. When in a Context Modifier, `info.memoryLength` and `info.maxChars` are also set, indicating the length of the memory portion of text (if any), and the total allowed length of the context after which it will be truncated.
## Last Model Input (LMI) ## Last Model Input (LMI)
Clicking on the brain icon in the scripting interface will open LMI, in which you can see the last context the AI was provided, the console, and the state. Clicking on the brain icon in the scripting interface will open LMI, in which you can see the last context the AI was provided, the console, and the state.