@outwalk/skylark NPM

Skylark

Skylark is a high performance 2D game engine, designed for building cross platform games.

Skylark is still in its early stages and the API is subject to change with any update until v1.0.0

More information, tests, and examples are coming soon!

Installation

Install using npm:

npm install --save @outwalk/skylark

Install using yarn:

yarn add @outwalk/skylark

You can learn the API by reading the documentation.

Getting Started

Skylark allows you to structure your game code however you like, but the easiest structure to get up and running with a proper game loop is using the Screen class.

Example:

/* create the initial game screen */
class Game extends Screen {

    async create() {

    }

    update() {

    }

    render() {

    }

    dispose() {

    }
}

/* start the game */
Screen.setScreen(new Game());

Screen.setScreen(screen); will run the screen's create method, call the update and render functions in the game loop, and when you change the screen again, the dispose method is called.

Building from source

To build the engine from source, follow these steps:

Steps	Command
Clone the repository	`git clone https://github.com/jleeson/skylark.git`
Install the tools	`npm install`
Build the project	`npm run build`
Generate the docs	`npm run docs`

Why?

Skylark was developed to make cross platform game development easy without sacrificing performance. Skylark is built with an object oriented design to make the code structure up to the user. After using other JavaScript game engines, they felt very opinionated, and so I set out to develop Skylark with as little required structure as possible.