MKScriptTemplate

Mister Keyboard script template with typings.

Getting Started

Online Editor (Recommended)

1. Fork this repository
2. Press the . key to open the project in GitHub Codespaces
3. Voilà! Edit the src/script.ts file and start scripting right away!

Tip

You can create and manage as many scripts as you want! Just make sure they're in the src/ folder, and that the file ending is .ts.

Local Editor (Advanced)

1. Fork this repository (recommended), or download it as a ZIP and extract it.
2. Open the project folder in your favorite code editor (e.g. Visual Studio Code).
3. Run npm install¹ in the terminal to install the necessary dependencies.
4. Simply edit the src/script.ts file!

If your editor is set up correctly, you should get autocompletion, type checking and inline documentation for the full Mister Keyboard Scripting API.

Building

If you write normal JavaScript code, you can simply copy your script straight into Mister Keyboard.

Important

If you want to use TypeScript features (like types, interfaces, etc.), you need to compile your code first. You can do this by running npm run build in the terminal. This will create a dist/<your_script>.js file that you can then load into Mister Keyboard.

Upgrading

The Mister Keyboard scripting API is still in active development, and regularly receives new features and improvements. If you obtained this template in the recommended way (by forking this repository), you can easily pull in the latest changes by running git pull² in the terminal.

Footnotes

1. Requires Node.js to be installed on your system. ↩

2. Requires Git to be installed on your system. ↩