hexxi

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 and include it

   <script src="hexxi.js">
   

2. Require Hexxi

   Hexxi = require('hexxi')
   

3. Configure Hexxi

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

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

• board
• grid_tile
• unit
• team

#####Components The following are included in core

Some pruning may occur

• views
  • view
  • circle
  • sprite
  • text
• animations
• clickable
• component
• hex_grid
• hex_position
• highlight
• hover_effects
• pathable
• position
• relations
• selectable
• team
• team_membership
• tile
• user

#####Systems The following are included in core

• animations
• command_queue
• hex_grid
• highlights
• hover_effects
• input
• multiplayer
• pathing
• relations
• renderer
• selectables
• teams
• users

#####Animations Animations are used to move entities around. They must emit a complete event when done.

Two builtin animations are provide:

• linear: Move directly to another hex position
• hex_path: Move along a series of hex positions

#####Commands Commands are used to represent a result of player input. Hexxi comes with a builtin move command as an example.

Commands should be lightweight and delegate their work to relevant systems.

#####Multiplayer Status: In progress

• Extending primus.io server side to support users
• Extending client multiplayer component
• Currently two clients can connect and have their moves mirrored.