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

Ebiten (海老天)

v{{.StableVersion}}

A simple SNES-like 2D game library in Go
Works on
- Web browsers (powered by GopherJS)
  - Supported browsers: Chrome, Firefox, Safari on desktops
- Mac OS X
- Linux (maybe)
- Windows (possibly)
API Docs
GitHub project page (Development version: v{{.DevVersion}})

Features

2D Graphics
Input (Mouse, Keyboard, Gamepad)

Example

{{range .Examples}} {{end}}

Install on Mac OS X

:; 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 Ubuntu Linux

Before installing Ebiten, you might need these libraries:

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

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.

Apps created with Ebiten

Plasma by Peter Hellberg
go-inovation5 by Hajime Hoshi
Wired Logic by Martin Kirsche

Change Log

2016-02-17

v1.2.0-rc1 released.
- Added support for gamepads on desktops and browsers
- Added support for touch events on browsers
- Added new functions for image rendering:
  - Image.ReplacePixels
  - GeoM.Rotate
  - ColorM.RotateHue
- Added some experimental packages:
  - exp/audio: Play music and sound
  - exp/gamepad: Useful functions to configure gamepads
  - These packages are experimental and we don't guarantee backward compatibility.
- Deprecated some APIs:
  - TranslateGeo (Use GeoM's Translate instead)
  - ScaleGeo (Use GoeM's Scale instead)
  - RotateGeo (Use GoeM's Rotate instead)
  - TranslateColor (Use ColorM's Translate instead)
  - ScaleColor (Use ColorM's Scale instead)
  - RotateHue (Use ColorM's RotateHue instead)
- Fixed some bugs
- Performance optimization

2015-01-25

v1.1.0 released.
- Fixed some bugs.

2015-01-10

v1.1.0-rc1 released.
- Support for web browsers: Ebiten now includes support for web browsers with GopherJS.
- Some API has changed:
  - ImagePart is deprecated. Use ImageParts interface instead.
  - ColorM.Element and GeoM.Element's recievers changed from structs to pointers.
  - A lot of keyboard keys have been added. KeyMax and MouseButtonMax were removed.
- The game is stopped when the window is not active.

2015-01-04

v1.0.0 released.
- Nothing has changed from v1.0.0-rc1.

2014-12-29

v1.0.0-rc1 released.

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.