You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Alexander Yakovlev cc4fe2c9ee Dependency update 2023 1 month ago
game custom tag for choice subtitles 2 years ago
html The undo button 2 years ago
js Gamepad code (untested) 2 years ago
scss Dependency update 2023 1 month ago
.browserslistrc readme 2 years ago
.gitattributes Added a screenshot 2 years ago
.gitignore gitignore 2 years ago JSON mappings add another 200k in size 2 years ago
package.json Dependency update 2023 1 month ago
pnpm-lock.yaml Dependency update 2023 1 month ago
postcss.config.js Webpack instead of Gulp and a restart button 3 years ago
screenshot.png Added a screenshot 2 years ago
webpack.config.js Spawn inklecate on build 2 years ago

inkjs boilerplate

This is a cross-platform template, but auto-rebuilding is set for Linux only. Hence the repository title. Edit the auto-rebuilding script for your system.

Console commands to start working

  1. git clone
  2. npm install or better pnpm install
  3. webpack prod and you'll have the game in the build folder.

If you need a lighter template without any console commands: inkjs-boilerplate.




  • Autosaving (with a restart button)
  • Keyboard support (press 1-9 to select 1th-9th choices, 0 to choose 10th)
  • Gamepad support (arrows or Y axis to select, A to choose)
  • Great performance (no fancy tricks, pure DOM manipulation)
  • For authors: npm watch will auto-recompile the game on changes to JS or JSON
    • Auto-recompiling from ink to JSON is not included, though
  • Mobile-ready layout
  • Editable color scheme
  • Undo button (just delete it from HTML code if you don't want it)


Compatible browsers: Chrome >= 60, Firefox >= 60, iOS >= 12, Safari >= 12.