ebiten/README.md

59 lines
2.3 KiB
Markdown
Raw Normal View History

2019-03-21 17:27:01 +01:00
# Ebiten
2014-10-12 06:09:19 +02:00
2014-12-28 14:27:07 +01:00
[![Build Status](https://travis-ci.org/hajimehoshi/ebiten.svg?branch=master)](https://travis-ci.org/hajimehoshi/ebiten)
2016-04-19 16:30:02 +02:00
[![GoDoc](https://godoc.org/github.com/hajimehoshi/ebiten?status.svg)](http://godoc.org/github.com/hajimehoshi/ebiten)
2016-05-13 17:27:17 +02:00
[![Go Report Card](https://goreportcard.com/badge/github.com/hajimehoshi/ebiten)](https://goreportcard.com/report/github.com/hajimehoshi/ebiten)
2016-04-19 16:30:02 +02:00
2019-03-21 17:27:01 +01:00
**A dead simple 2D game library in Go**
Ebiten is an open-source game library, with which you can develop 2D games with simple API for multi platforms in the Go programming language.
2016-08-27 19:58:37 +02:00
2019-03-21 14:17:13 +01:00
* [Website (ebiten.org)](https://ebiten.org/)
* [Cheat Sheet](https://ebiten.org/cheatsheet.html)
2018-02-19 18:21:37 +01:00
2019-03-21 14:11:27 +01:00
<p><a href="https://ebiten.org/examples/flappy.html"><img src="https://ebiten.org/images/examples/flappy.png" width="640" height="480" alt="flappy"></a></p>
2018-09-12 19:06:16 +02:00
2018-02-19 18:21:37 +01:00
## Platforms
2019-03-23 20:32:21 +01:00
* Windows (No Cgo!)
* macOS
* Linux
* FreeBSD
2019-08-18 11:33:51 +02:00
* Android
* iOS
2018-06-27 04:55:28 +02:00
* Web browsers (Chrome, Firefox, Safari and Edge)
* [GopherJS](https://github.com/hajimehoshi/ebiten/wiki/GopherJS)
* [WebAssembly](https://github.com/hajimehoshi/ebiten/wiki/WebAssembly) (Experimental)
2014-10-12 06:09:19 +02:00
Note: Gamepad and keyboard are not available on Android/iOS.
2016-11-26 16:11:23 +01:00
2019-03-23 20:32:21 +01:00
For installation on desktops, see [the installation instruction](https://ebiten.org/install.html).
2014-12-24 02:00:09 +01:00
## Features
2014-10-12 06:09:19 +02:00
2018-10-11 18:25:49 +02:00
* 2D Graphics (Geometry/Color matrix transformation, Various composition modes, Offscreen rendering, Fullscreen, Text rendering, Automatic batches, Automatic texture atlas)
2016-08-28 00:08:50 +02:00
* Input (Mouse, Keyboard, Gamepads, Touches)
2018-10-11 18:27:17 +02:00
* Audio (Ogg/Vorbis, MP3, WAV, PCM)
2014-12-24 02:00:09 +01:00
2018-02-19 18:21:37 +01:00
## Packages
* [ebiten](https://godoc.org/github.com/hajimehoshi/ebiten)
* [audio](https://godoc.org/github.com/hajimehoshi/ebiten/audio)
* [mp3](https://godoc.org/github.com/hajimehoshi/ebiten/audio/mp3)
* [vorbis](https://godoc.org/github.com/hajimehoshi/ebiten/audio/vorbis)
* [wav](https://godoc.org/github.com/hajimehoshi/ebiten/audio/wav)
* [ebitenutil](https://godoc.org/github.com/hajimehoshi/ebiten/ebitenutil)
* [inpututil](https://godoc.org/github.com/hajimehoshi/ebiten/inpututil)
* [mobile](https://godoc.org/github.com/hajimehoshi/ebiten/mobile)
* [text](https://godoc.org/github.com/hajimehoshi/ebiten/text)
2014-12-27 15:27:37 +01:00
## Community
### Slack
`#ebiten` channel in [Gophers Slack](https://blog.gopheracademy.com/gophers-slack-community/)
2014-10-12 06:09:19 +02:00
## License
2015-05-20 16:57:03 +02:00
Ebiten is licensed under Apache license version 2.0. See LICENSE file.