ebiten README

The project's README from github.com/hajimehoshi/ebiten. As one markdown file: README.md.

Ebitengine (v2)

Go Reference Build Status

A dead simple 2D game engine for Go

Ebitengine (formerly known as Ebiten) is an open source game engine for the Go programming language. Ebitengine's simple API allows you to quickly and easily develop 2D games that can be deployed across multiple platforms.

Overview

Platforms

For installation on desktops, see the installation instruction.

Features

Packages

AI coding agents

If you use an AI coding agent to write or modify Ebitengine code or applications, point it at the skills directory, which holds skills for working with this repository.

Community

License

Ebitengine is licensed under Apache license version 2.0. See LICENSE file.

The Ebitengine logo by Hajime Hoshi is licensed under the Creative Commons Attribution 4.0.

Ebitengine bundles third-party libraries. See NOTICE.md for their licenses.

ebiten (hajimehoshi/ebiten)

Searching Database…

13.6K ·GitHub
What is this?Ebitengine (formerly Ebiten) is an open source 2D game engine for Go: a simple API for building 2D games that deploy across many platforms.
Is it a full engine, or a library of pieces I assemble myself?A full engine: you write your game in Go against its API, and it ships as a set of packages — ebiten, audio, text/v2, vector, mobile — that cover graphics, input and sound.
How do I get it into a Go project?Add it as a dependency of your Go project; for desktop setup the README points to the installation instructions on ebitengine.org.
Do all those targets build straight from Go, or do some need extra tooling?Desktop and WebAssembly targets are plain Go; Android, iOS, Switch and Xbox need Cgo, and Xbox support is limited and not available to everyone yet.
Where can a game built with it actually run?Windows, macOS, Linux, FreeBSD, Android, iOS and WebAssembly, plus Nintendo Switch and Xbox.
What does the engine cover out of the box?2D graphics with matrix-based geometry and color transforms, composition modes, offscreen rendering, text rendering, automatic batches and texture atlases, and custom shaders; input from mouse, keyboard, gamepads and touches; audio in Ogg/Vorbis, MP3, WAV and PCM.
How steep is the learning curve for a Go developer?Gentle by design — the whole pitch is a dead simple API for quickly and easily building 2D games, with an API reference and cheat sheet on ebitengine.org. Knowing Go is the main prerequisite.
What are the exp/ packages about?Alongside the stable core (ebiten, audio, text/v2, vector) the README lists experimental packages: exp/shaderprecomp, exp/textinput and exp/vmhost. They are add-ons still marked experimental, so expect them to be less settled than the core.
Can I point an AI coding agent at this repo?Yes. The repo has a skills directory holding skills for working with the repository — point your AI coding agent at it when writing or modifying Ebitengine code or applications.
What are similar projects?bgfx, raylib, libgdx, flame, ArcadeMaker, iw4L, OpenDiablo2, egui
Size
113 MB
Stars
13.6K
Age
13y
Commits · 90 Days