ABANDONED - A tiny 2D game framework for the web.
Switch branches/tags
Nothing to show
Clone or download
Otto Robba
Otto Robba Update README.md
Latest commit 2742b97 Sep 16, 2017

README.md

Disclaimer

I'm not working on this anymore. Feel free to do with it as you will!

ox

Ox is a tiny, opinionated-yet-open 2D game framework for the web. It offers a rigid structure that facilitates development. Its goals are to be easy to learn, modular and lightweight.

It weights at ~3.8kbytes gzipped and minified, meaning it can be easily used for competitions like 13kJS and for mobile games.

Features

  • Powerful and simple Entity system
  • Fixed time step game loop
  • Transparent canvas context
  • Animated sprites
  • Scene manager
  • Assets preloading
  • Automated asset management, live server reload
  • Tiny at 3.8kbytes

Anatomy of an Ox project

Upon cloning this repo (or downloading it), you should have a basic skeleton for a game.

  • audio
  • build
  • data
  • images
  • src
    • engine
    • entities
    • scenes

Getting started:

Download the framework with the basic template, then cd to the folder you extracted and run npm install. Then just run npm start. Now just start developing! :D

You can read more information on the documentation.

Note: This branch is constantly modified, use the release channel for stable releases


Roadmap

  • Special UI entity
  • Tweening
  • Particles
  • Pre-Rendering
  • Pruning of code base
  • Better sample project
  • Better loading scene
  • Less dependencies
  • Powerful plugin architecture
  • Video documentation