wyrm-engine
Advanced tools
Comparing version 1.0.5 to 1.0.6
@@ -5,3 +5,3 @@ { | ||
"email": "momatoku@gmail.com", | ||
"version": "1.0.5", | ||
"version": "1.0.6", | ||
"description": "Fully typed game engine library designed to simulate battles between virtual characters", | ||
@@ -8,0 +8,0 @@ "main": "./bundles/index.umd.js", |
# wyrm-engine | ||
[![Build Status](https://travis-ci.com/SirWojtek/wyrm-engine.svg?branch=master)](https://travis-ci.com/SirWojtek/wyrm-engine) | ||
[![codecov](https://codecov.io/gh/SirWojtek/wyrm-engine/branch/master/graph/badge.svg)](https://codecov.io/gh/SirWojtek/wyrm-engine) | ||
![npm](https://img.shields.io/npm/v/wyrm-engine) | ||
wyrm-engine is fully typed game engine library which is designed to simulate battles between in-game characters. | ||
@@ -81,2 +83,15 @@ The main goal of wyrm-engine is to abstract the battle logic from the rest of the game, which makes it usable | ||
## Instalation | ||
### Via npm | ||
``` | ||
npm install wyrm-engine | ||
``` | ||
### Via yarn | ||
``` | ||
yarn wyrm-engine | ||
``` | ||
## API docs | ||
API documentation is available here: [Docs](https://wyrm-engine-docs.s3.eu-central-1.amazonaws.com/index.html) | ||
## Usage | ||
@@ -83,0 +98,0 @@ To create an ecounter, you first need to prepare battleground, which includes defining characters and sides of conflict. |
3124047
405