The AI Dungeon TypeScript Toolkit is a repository template that enables developers to build custom scripts for AI Dungeon using TypeScript. Use modules, write unit-tests, and import packages to enhance your scripting capabilities!
- Write scripts in TypeScript, a statically-typed superset of JavaScript.
- Format your code with Prettier.
- Lint your code with ESLint.
- Write unit-tests with Jest.
- Package your scripts for deployment with Webpack.
- Clone the repository.
- Install the dependencies with
npm install
. - Edit scripting hooks in the
src/mygame.ts
file. - Build for deployment with
npm run build
. - Copy content of the
dist/*.js
files to the AI Dungeon script editor.
Other commands:
npm run lint
- Lint the code with ESLint and TypeScript.npm run format
- Format the code with Prettier.npm run test
- Run the unit-tests with Jest.npm run watch
- Watch for changes and test automatically.
This project is licensed under the MIT License - see the LICENSE file for details.