Hexxi NPM | npm.io

Hexxi v0.1.0

A HTML5 engine for creating hex based games.

##Getting started 1. Install via npm

```
npm install hexxi
```

or the oldschool way: [Download Hexxi](https://raw.githubusercontent.com/gwilymhumphreys/hexxi/master/build/hexxi.js) and include it

```
<script src="hexxi.js">
```

Require Hexxi
```
Hexxi = require('hexxi')
```

Configure Hexxi

Hexxi.configure({ /* see `Configuration` below */ })

Start Hexxi
```
Engine = Hexxi.Engine
Engine.start()
```

##Configuration

####Paths Tell Hexxi where to find your own commands and systems with the paths property. These paths are added to Hexxi's internal list of module paths and all are loaded on init().

Hexxi.configure({
  paths:
    commands: 'awesomegame/commands/'
    systems: 'awesomegame/systems/'
})

#####Systems Hexxi provides a number of builtin systems (see below). With the systems property you can, per system

Configure their individual options by providing an object (see below for system options)
Replace the system with a class of your own by providing a class inheriting from System
Replace the system with an instance of your own class

Hexxi.configure({
  paths:
    commands: 'awesomegame/commands/'
    systems: 'awesomegame/systems/'
  systems:
    # Builtin
    hex_grid:
      type: 'pointy'
      tile_size: 36
      rows: 7
      columns: 7
    # By class
    multiplayer: MyAwesomeMultiplayerSystem
    # By instance
    pathing: new MyPathingThing({some_options: 'yeah man'})
})

##Current status of various modules

#####API Status: In progress

Expect changes!

#####Entities The following base entities are included in core