Go to file
2023-02-22 00:40:09 +06:00
game custom tag for choice subtitles 2020-11-07 17:16:38 +07:00
html The undo button 2021-08-26 20:36:47 +07:00
js Gamepad code (untested) 2021-09-20 20:31:15 +07:00
scss Dependency update 2023 2023-02-22 00:40:09 +06:00
.browserslistrc readme 2021-08-24 15:42:20 +07:00
.gitattributes Added a screenshot 2020-11-08 00:20:02 +07:00
.gitignore gitignore 2021-08-24 16:09:36 +07:00
package.json Dependency update 2023 2023-02-22 00:40:09 +06:00
pnpm-lock.yaml Dependency update 2023 2023-02-22 00:40:09 +06:00
postcss.config.js Webpack instead of Gulp and a restart button 2020-06-10 19:20:46 +07:00
README.md JSON mappings add another 200k in size 2021-09-20 20:32:43 +07:00
screenshot.png Added a screenshot 2020-11-08 00:20:02 +07:00
webpack.config.js Spawn inklecate on build 2021-08-14 14:21:51 +07:00

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.

Screenshot

Screenshot

Features

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

Compatibility

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