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-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**
2020-04-09 06:21:14 +02:00
Ebiten is an open source game library for the Go programming language. Ebiten's simple API allows you to quickly and easily develop 2D games that can be deployed across multiple platforms.
2016-08-27 19:58:37 +02:00
2020-01-19 17:18:00 +01:00
* [Website (ebiten.org)](https://ebiten.org)
* [API Reference](https://pkg.go.dev/github.com/hajimehoshi/ebiten)
* [Cheat Sheet](https://ebiten.org/documents/cheatsheet.html)
2018-02-19 18:21:37 +01:00
![Overview](https://ebiten.org/images/overview1.11.png)
2019-11-02 09:38:01 +01: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
2020-01-19 17:18:00 +01:00
For installation on desktops, see [the installation instruction](https://ebiten.org/documents/install.html).
2019-03-23 20:32:21 +01:00
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://pkg.go.dev/github.com/hajimehoshi/ebiten)
* [audio](https://pkg.go.dev/github.com/hajimehoshi/ebiten/audio)
* [mp3](https://pkg.go.dev/github.com/hajimehoshi/ebiten/audio/mp3)
* [vorbis](https://pkg.go.dev/github.com/hajimehoshi/ebiten/audio/vorbis)
* [wav](https://pkg.go.dev/github.com/hajimehoshi/ebiten/audio/wav)
* [ebitenutil](https://pkg.go.dev/github.com/hajimehoshi/ebiten/ebitenutil)
* [inpututil](https://pkg.go.dev/github.com/hajimehoshi/ebiten/inpututil)
* [mobile](https://pkg.go.dev/github.com/hajimehoshi/ebiten/mobile)
* [text](https://pkg.go.dev/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.