A basic template for deploying a game written in ink as a stand-alone desktop app. Uses inkJS, NW.js, Stylus with Axis, Jeet and Rupture, Pug and jQuery. Primarily tested on OSX El Capitan, should theoretically work on Windows and Linux.
Put together and maintained by Isak Grozny. Forks, pull requests and other contributions very much welcome.
These instructions written with the assumption that you don't know what any of these files do.
- Install Make, if you don't have it already. If you're a Windows user, you probably don't have it.
- Install Node.js if you don't have it already. Node.js ships with NPM, so that's two birds in the hand.
- After you have Node.js and NPM, install Bower.
- Install Gulp by running
npm i -g gulp-cliin the commandline. This installs the Gulp CLI. If you already have it, make sure it's up-to-date, because this repository uses Gulp 4.
After you've done all that, clone or download this repository, open it on the commandline and run:
make -f Makefile-init
This sets up the repository for developing your ink app.
To load your own game into the app, edit
line 7 in
assets/js/game.js -- replace
the-intercept.json with your own compiled ink file. For instructions on how to compile
.ink files into
.json, see ink's repo.
Customizing the App
- To change the appearance of the app, edit
gulp cssfrom the commandline.
- To change the HTML layout, edit
gulp htmlfrom the commandline.
- To change the behaviour of the app, edit
index.pug. Refer to NW.js docs if you want to do things like add a menu, make the app fullscreen, etcetera.
gulp jsfrom the commandline to concat (combine) and compile the scripts.
- Add licenses
- Make the
.jsfiles easier to customize for novices
- Make several different templates for presenting text adventures
- Implement loading images, sprites and audio
- Make sure to include
@require 'jeet'at the top of
main.stylfor the time being, as Jeet is not importing properly from the Gulp task.