KiiGame Adventure Engine

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

• Node.js and npm
• Konva
• Mocha, Chai and Sinon.JS for unit tests
• Conventional Commits, commitlint and commitlint-plugin-tense
• 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

• Install Node.js and npm (for example see https://docs.npmjs.com/downloading-and-installing-node-js-and-npm)
• Clone the repository
• Run the following to install dependencies and set up project configurations:

npm install
npm run prepare

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.

Local manual testing/playing

• Run npm run build-dev to build a development bundle. The bundle is built to the public/ directory.
• Run npm start to launch local web server
• Navigate to 127.0.0.1:8080 in your browser - the example game should launch

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

Building the library bundle

npm run build builds the library bundle to dist/.