Setup location for contributed scripts

This commit is contained in:
Andrew Cantino 2020-09-27 10:59:20 -07:00
parent 2dfd05d42b
commit ddf4d627c0
2 changed files with 17 additions and 1 deletions

View file

@ -3,7 +3,7 @@
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](examples)
You can check out some examples for how to use scripting [here](examples). We also have [user contributed scripts here](contributed).
## 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.

16
contributed/README.md Normal file
View file

@ -0,0 +1,16 @@
# User Contributed Scripts
This directory contains scripts contributed by our wonderful AI Dungeon users.
## Contributing Scripts
We'd love for you to add your scripts too! If you'd like to contribute, please fork this repo and send a pull request
with a new subdirectory under this directory, named for what the script does, containing your script(s) and a README.md
file explaining how to use the them. Please also include a license in the README.md file (we recommend [MIT](https://opensource.org/licenses/MIT)).
Also, note that we do not currently accept NSFW scripts.
## External links
The following are links to more AID scripts located externally.
* More soon! Please send PRs.