ebiten Documentation

File: README.md Copy Chapter

Ebitengine (v2)

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.

• Website (ebitengine.org)
• API Reference
• Cheat Sheet
• Awesome Ebitengine

Platforms Copy Chapter

• Windows
• macOS
• Linux
• FreeBSD
• Android (Cgo required)
• iOS (Cgo required)
• WebAssembly
• Nintendo Switch (Cgo required)
• Xbox (Cgo required) (Xbox support is limited and not available to everyone. Negotiations are currently underway to make it accessible to all.)

For installation on desktops, see the installation instruction.

Features Copy Chapter

• 2D Graphics (Geometry and color transformation by matrices, Various composition modes, Offscreen rendering, Text rendering, Automatic batches, Automatic texture atlas, Custom shaders)
• Input (Mouse, Keyboard, Gamepads, Touches)
• Audio (Ogg/Vorbis, MP3, WAV, PCM)

Packages Copy Chapter

• ebiten
  • audio
    • mp3
    • vorbis
    • wav
  • colorm
  • ebitenutil
  • inpututil
  • mobile
  • text/v2
  • vector
  • exp/shaderprecomp
  • exp/textinput
  • exp/vmhost

AI coding agents Copy Chapter

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 Copy Chapter

• Discord
• #ebitengine channel in Gophers Slack
• GitHub Discussion
• r/ebitengine in Reddit

License Copy Chapter

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.

File: internal/graphicsdriver/metal/README.md Copy Chapter

These packages are copied from Dmitri Shuralyov's mtl packages and edited with Dmitri's permission:

• github.com/hajimehoshi/ebiten/v2/internal/graphicsdriver/metal/ca (copied from dmitri.shuralyov.com/gpu/mtl/example/movingtriangle/internal/ca)
• github.com/hajimehoshi/ebiten/v2/internal/graphicsdriver/metal/mtl (copied from dmitri.shuralyov.com/gpu/mtl)
• github.com/hajimehoshi/ebiten/v2/internal/graphicsdriver/metal/ns (copied from dmitri.shuralyov.com/gpu/mtl/example/movingtriangle/internal/ns)

File: internal/graphicsdriver/opengl/gl/README.md Copy Chapter

This is a fork of github.com/go-gl/gl/v2.1/gl with the below patch. This is now modified manually.

The original version is generated from github.com/hajimehoshi/glow's nocgo branch. This enables to remove dependencies on Cgo on Windows.

Now we are working on committing this 'no-cgo' change to the official gl package. See https://github.com/go-gl/glow/pull/102.

File: misc/README.md Copy Chapter

How to use the images

You have to add a note describing that the Ebitengine logo by Hajime Hoshi is licensed under the Creative Commons Attribution 4.0 somewhere in your application.