{{comment .License}} Ebiten - A simple SNES-like 2D game library in Go

Ebiten (海老天)

Stable version: v{{.StableVersion}} / Development version: v{{.DevVersion}}

A simple SNES-like 2D game library in Go
Works on
- Web browsers (powered by GopherJS)
  - Supported browsers: Chrome and Firefox on desktops
- Windows
- Mac OS X
- Linux
- Android (WIP)
- iOS (WIP)

Features

2D Graphics
Input (Mouse, Keyboard, Gamepad)
Audio (Ogg/Vorbis, WAV, and PCM)

Example

Install on Mac OS X or Windows

Compilation requires a C compiler like GCC to compile third party libaries used by Ebiten. You would need MinGW on Windows, and would need Xcode on Mac OS X.

Let's get the Ebiten source code and compile it.

:; go get github.com/hajimehoshi/ebiten

If you want to run your game on a web browser, execute this:

:; go get github.com/gopherjs/gopherjs
:; go get github.com/gopherjs/webgl

Install on Linux

Before installing Ebiten, you might need these libraries:

libglu1-mesa-dev
libgles2-mesa-dev
libxrandr-dev
libxcursor-dev
libxinerama-dev
libxi-dev

Ebiten is tested on Ubuntu Linux x64.

Execute the example

:; cd $GOPATH/src/github.com/hajimehoshi/ebiten/examples
:; go run rotate/main.go

Run your game on a desktop

Just execute your Go program. That's it!

Run your game on a web browser

Compile your game with GopherJS:

:; gopherjs build -o yourgame.js path/to/yourgame

Then, open the below HTML on your HTTP server:

<!DOCTYPE html>
<script src="yourgame.js"></script>

NOTE: file:// URL may not work with Ebiten. Execute your game on a HTTP server.

Getting Started

Let's build a simple "Hello world!" game to get started with Ebiten. First create a new directory (mkdir hello_world), and change into it (cd hello_world). Type the following code into the main.go file:

package main

import (
    "github.com/hajimehoshi/ebiten"
    "github.com/hajimehoshi/ebiten/ebitenutil"
)

func update(screen *ebiten.Image) error {
    ebitenutil.DebugPrint(screen, "Hello world!")
    return nil
}

func main() {
    ebiten.Run(update, 320, 240, 2, "Hello world!")
}

Run the go run command to start the game. There you have it, your first Ebiten game!

Apps created with Ebiten

Plasma by Peter Hellberg
go-inovation by Hajime Hoshi
Wired Logic by Martin Kirsche
AwakEngine by Josh Deprez

Change Log

See GitHub releases page.

License

Ebiten

{{.License}}

Go Gopher photograph

The original photograph of Go gophers by Chris Nokleberg is licensed under the Creative Commons 3.0 Attributions license.