electron-noveljs-boilerplate

Create standalone Novel.js adventures!


Keywords
electron, boilerplate, novel-js, noveljs, novel.js, novel, text adventure, game engine, choose your own adventure, visual novel, text game, game, adventure, fiction, prose, interactive fiction, interactive
License
MIT
Install
npm install electron-noveljs-boilerplate@0.3.0

Documentation

electron-noveljs-boilerplate

Dependency Status devDependency Status npm version

A simple boilerplate for Novel.js using Electron. Electron allows you to create standalone desktop games with Novel.js for Windows, OSX and Linux.

Usage

  1. Install with npm install electron-noveljs-boilerplate or load the latest release zip.
  2. npm install to install Novel.js and Electron.
  3. Run Electron by executing the electron.exe file in node_modules/electron-prebuilt/dist/.
  4. Drag app/main.js in to the Electron window to test the game.

The game files are in app/novel/, and the main view in app/index.html. See Novel.js documentation to learn how to use them.

To learn more about Electron, see its documentation. To package a finished game, see Application Distribution in the Electron docs.

License

electron-noveljs-boilerplate is licensed under the MIT License. Copyright © Ville Talonpoika 2016