kiigame
=======

[![Netlify Status](https://api.netlify.com/api/v1/badges/697d2167-ec6d-4d1a-98dd-9ae075af4fd5/deploy-status)](https://app.netlify.com/sites/kgae/deploys)

KiiGame Adventure Engine is a HTML5/JavaScript based simple adventure game engine for web browsers. KGAE uses [Konva](https://konvajs.org), and Mocha, Chai and Sinon for unit tests.

The engine comes with an example game, [Lätkäzombit: Pako hallista](https://kgae.netlify.com/). The example game is in the Finnish language.

Take a look at the adventure creation guide: https://github.com/evktalo/kiigame/wiki/Adventure-creation-guide

How to test locally on Linux
----------------------------

The game is implemented as a web page. Therefore you need to run a web server on your machine to test it locally. Here are the steps:

 * Install and run Apache (for example see https://help.ubuntu.com/community/ApacheMySQLPHP)
 * Install npm (for example see https://www.sitepoint.com/beginners-guide-node-package-manager/)
 * Clone the repository (or just get the files)
 * Run `npm install` to get dependencies
 * Run `npm run dev` to build a development bundle. The bundle is built to the `public/` directory.
 * Put the files (including folders) to your webserver directory (for example `/var/www/`)
 * Open `kiigame.html` in your browser (for example `http://localhost/public/kiigame.html`)

Running unit tests
------------------

After installing with `npm install`, you should be able to run

 * `npm test`
 
in the project root to run the unit tests.

Building the library bundle
---------------------------

`npm run build` builds the library bundle to `dist/`.