Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/tomdionysus/tenkai

2D Browser Based Gaming Engine
https://github.com/tomdionysus/tenkai

Last synced: about 2 months ago
JSON representation

2D Browser Based Gaming Engine

Awesome Lists containing this project

README

        

# Tenkai

[![Build Status](https://img.shields.io/travis/tomdionysus/tenkai/master.svg)](https://travis-ci.org/tomdionysus/tenkai)
[![Coverage Status](https://coveralls.io/repos/github/tomdionysus/tenkai/badge.svg?branch=master)](https://coveralls.io/github/tomdionysus/tenkai?branch=master)
[![NPM version](https://img.shields.io/npm/v/tenkai.svg)](https://www.npmjs.com/package/tenkai)

Tenkai is a 2D game engine written in JavaScript. It is designed to create games that run in the browser using standard PNG/JPG/MP3 assets, supporting multiple nested scenes and entities (sprites/mobs), audio and sfx, and an event driven management system.

When combined with the [Electron](https://electronjs.org/) project, Tenkai can be used to build standalone games that run on a variety of platforms including Windows, MacOS and Linux.

## Installation

```
npm install tenkai
```

## Documentation

Tenkai is a set of ES2015 classes designed to be complied to a JS application for the browser using [Browserify](http://browserify.org/) or another similar toolchain. A blank game project with an on-demand complier and an [Electron](https://electronjs.org) build toolchain is available.

* *Concepts* - [See an overview of the concepts in Tenkai here](docs/concepts).
* *HOWTOs* - [See general HOWTOs and example projects here](docs/howotos).

### `npm` Package Documentation

* `tenkai` [tomdionysus.github.io/tenkai](https://tomdionysus.github.io/tenkai/)