Skip to content

Latest commit

 

History

History
33 lines (24 loc) · 1.08 KB

README.md

File metadata and controls

33 lines (24 loc) · 1.08 KB

AI Dungeon TypeScript Toolkit

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!

Features

  • 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.

Usage

  1. Clone the repository.
  2. Install the dependencies with npm install.
  3. Edit scripting hooks in the src/mygame.ts file.
  4. Build for deployment with npm run build.
  5. 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.

License

This project is licensed under the MIT License - see the LICENSE file for details.