Get started

Get started with Keel

Keel is available to invited teams while it is pre-1.0. Invited teams get the source, the documentation and the keel command-line tool. This page shows what the first hour looks like.
The first hour

From an empty folder to a packaged build

Four steps, all from the command line, so a person or an agent can follow them the same way.
01

Create a project

Pick a template: app, game2d, game3d or website. The project builds and runs straight away.keel new my-game --template game2d cd my-game keel run
02

Write your game or app

Game state lives in a world of entities and components that steps at a fixed rate. The interface is a tree of components, and keel::prelude brings both in.fn main() -> keel::Result<()> { keel::launch(runtime( |cx| World::create(cx, ()), |_world| empty(), )) }
03

Check it without a window

Render every scene headless, read the report and the PNGs, and run the tests. Runs are repeatable, so the same code gives the same pixels.keel scenes keel shot --json keel test
04

Package it

List the targets, then build a package for the web, desktop or Android.keel pack --list-profiles keel pack --profile web
Access by invitation

Keel Engine is invite-only for now

Keel is pre-1.0 and its source is private. We are working with a small number of teams building games, apps and websites. Invited teams get the source, the documentation and the keel command-line tool.To ask for an invitation, email:
hi@sylphx.com
defer> defer> defer> defer> defer> defer> defer>