Go to file

Alexander Yakovlev 79bcec3bfc linux note		2021-08-25 23:10:46 +07:00
game	custom tag for choice subtitles	2020-11-07 17:16:38 +07:00
html	update style	2021-08-24 16:07:55 +07:00
js	update style	2021-08-24 16:07:55 +07:00
scss	update style	2021-08-24 16:07:55 +07: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	Keyboard support	2021-08-24 15:24:49 +07:00
pnpm-lock.yaml	Spawn inklecate on build	2021-08-14 14:21:51 +07:00
postcss.config.js	Webpack instead of Gulp and a restart button	2020-06-10 19:20:46 +07:00
README.md	linux note	2021-08-25 23:10:46 +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

README.md

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

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

Screenshot

Features

Autosaving (with a restart button)
Keyboard support (press 1-9 to select 1th-9th choices, 0 to choose 10th)
Great game performance (all JS is ~200Kb in size with Inkjs runtime)
For authors: npm watch will auto-recompile the game on changes to JS or JSON

Compatibility

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

If you want to support older browsers (released before 2018), you'll have to rewrite the CSS. I use Bootstrap 5 because it's a good framework but it's also very modern. Other than that, the code depends only on inkJS and jQuery so it should comfortably support IE9+