nathan-a-macleod/budgie

Budgie

A lightweight HTML5 game engine for arcade-style games in the browser. Provides a simple API to manage sprites and visual/audial assets. Brought to you by LugoCorp.

Usage

Download

# This downloads the Github repository
git clone https://github.com/lugocorp/budgie
cd budgie

Installation

# This installs the budgie command on your machine
npm install -g budgiejs

Create a project

# This is how you start a new Budgie.js project
budgie init <name>
cd <name>

Build your game

# This will convert your project code into a website
budgie build

# This will fix a bug that can sometimes happen
budgie package

Open in the browser

# Once you've built your game you can open it in the browser for testing
budgie open

budgie.json details

name

A string that represents the name of your project. It will be displayed in the title bar of your browser.

latency

This integer value represents the number of milliseconds in between each frame of your game's runtime. Set this to a lower number for higher FPS (but it may cause performance issues if you go too low).

viewport

This is an object with two keys, width and height. They're both integer values that represent the number of in-game pixels in either dimension along your game screen. Your game is automatically scaled from this ratio to fit within the browser window.

Links

• Devlog series on the development of this project
• GitHub repository
• NPM page