Scripting

Custom scripts on AI Dungeon scenarios allow you to modify the memory, input, and output as well as keep track of custom state objects that might be relevant for your adventure. You can write custom scripts in Javascript by going to the "Scripts" section while on web on the edit scenario page. For security reasons some Javascript functionality is locked down however. Submit a request if there is functionality you would like opened up and we can look into it.

Examples

You can check out some examples for how to use scripting here

Don't Know How to Code?

Then now's a great time to learn! A good resource to learn javascript from scratch is this free course.

https://www.codecademy.com/courses/introduction-to-javascript

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.

Input Modifier

Called each time the player gives an input and has the opportunity to modify that input.

Output Modifier

Called each time the model generates an output and has the opportunity to modify that output.

World Entries

You can modify and read from the worldEntries parameter (same as world info that you can set on the scenario) allowing you to dynamically change it based on what's happening.

State

The state variable can be used to store information that's persistent across function calls.

• The state.memory.context value will be added to the games memory if exists
• The state.message value will be displayed as a extra message in the game (if it exists)
• You can set any variable on state to store and modify adventures throughout an adventure.

Console

console.log("Some message") will log messages that you can see in the scripting console