README.md

KiiGame Adventure Engine

KiiGame Adventure Engine is a HTML5/JavaScript based simple adventure game engine for web browsers. KGAE uses:

• Konva
• Mocha, Chai and Sinon.JS for unit tests
• Conventional Commits and commitlint
• InversifyJS for dependency injection
• Semantic Versioning

The engine comes with an example game, Lätkäzombit: Pako hallista. The example game is in the Finnish language.

There is an editor to create games using KGAE: check out kged here.

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

Development

WIP

Branching strategy

• Start a branch from main branch with a descriptive name
• Create a pull request towards main

Releases

• main branch is tagged for releases
• Maintenance branches can be created for old versions

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/.