From ddf4d627c05539b072786bfba2a6232a277e96b3 Mon Sep 17 00:00:00 2001 From: Andrew Cantino Date: Sun, 27 Sep 2020 10:59:20 -0700 Subject: [PATCH] Setup location for contributed scripts --- README.md | 2 +- contributed/README.md | 16 ++++++++++++++++ 2 files changed, 17 insertions(+), 1 deletion(-) create mode 100644 contributed/README.md diff --git a/README.md b/README.md index 2eaaf63..046237d 100644 --- a/README.md +++ b/README.md @@ -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. diff --git a/contributed/README.md b/contributed/README.md new file mode 100644 index 0000000..95f2535 --- /dev/null +++ b/contributed/README.md @@ -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. \ No newline at end of file