Getting Started

Below are instructions for getting started with suki.js.

Installation

npm install @roryduncan/suki

Using Suki.js

Suki.js is composed of multiple ES6+ modules. To use the core aspect of suki.js you simply import it:

import { suki } from "@roryduncan/suki";

A barebones example of importing suki and starting it up is below:

import { suki } from "@roryduncan/suki";

suki.whenReady(() => suki.start());

...and that is it. 🎉

Though all that did was start the render loop. Read on ahead to learn how to draw and all the fun stuff.

Next Up

Check out the examples for the next steps.

Want a full example? Check out this repository!