ebiten/README.md

60 lines
2.8 KiB
Markdown
Raw Normal View History

2020-10-15 06:44:22 +02:00
# Ebiten (v2)
2014-10-12 06:09:19 +02:00
2021-04-23 20:52:45 +02:00
[![Go Reference](https://pkg.go.dev/badge/github.com/hajimehoshi/ebiten/v2.svg)](https://pkg.go.dev/github.com/hajimehoshi/ebiten/v2)
2020-08-16 18:04:23 +02:00
[![Build Status](https://github.com/hajimehoshi/ebiten/workflows/test/badge.svg)](https://github.com/hajimehoshi/ebiten/actions?query=workflow%3Atest)
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
2020-05-14 10:40:47 +02:00
**A dead simple 2D game library for Go**
2019-03-21 17:27:01 +01:00
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)
2020-10-03 22:07:08 +02:00
* [API Reference](https://pkg.go.dev/github.com/hajimehoshi/ebiten/v2)
* [Cheat Sheet](https://ebiten.org/documents/cheatsheet.html)
2018-02-19 18:21:37 +01:00
2021-09-23 07:18:26 +02:00
![Overview](https://ebiten.org/images/overview2.2.png)
2019-11-02 09:38:01 +01:00
2018-02-19 18:21:37 +01:00
## Platforms
2020-05-09 21:14:56 +02:00
* [Windows](https://ebiten.org/documents/install.html?os=windows) (No Cgo!)
* [macOS](https://ebiten.org/documents/install.html?os=darwin)
* [Linux](https://ebiten.org/documents/install.html?os=linux)
* [FreeBSD](https://ebiten.org/documents/install.html?os=freebsd)
* [Android](https://ebiten.org/documents/mobile.html)
* [iOS](https://ebiten.org/documents/mobile.html)
2020-10-06 17:59:44 +02:00
* [WebAssembly](https://ebiten.org/documents/webassembly.html)
* Nintendo Switch™
2014-10-12 06:09:19 +02:00
Note: Gamepads and keyboards are not available on 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
2021-05-27 03:47:31 +02:00
* 2D Graphics (Geometry and color transformation by matrices, Various composition modes, Offscreen rendering, Text rendering, Automatic batches, Automatic texture atlas, Custom shaders)
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
2020-10-03 22:07:08 +02:00
* [ebiten](https://pkg.go.dev/github.com/hajimehoshi/ebiten/v2)
* [audio](https://pkg.go.dev/github.com/hajimehoshi/ebiten/v2/audio)
* [mp3](https://pkg.go.dev/github.com/hajimehoshi/ebiten/v2/audio/mp3)
* [vorbis](https://pkg.go.dev/github.com/hajimehoshi/ebiten/v2/audio/vorbis)
* [wav](https://pkg.go.dev/github.com/hajimehoshi/ebiten/v2/audio/wav)
* [ebitenutil](https://pkg.go.dev/github.com/hajimehoshi/ebiten/v2/ebitenutil)
* [inpututil](https://pkg.go.dev/github.com/hajimehoshi/ebiten/v2/inpututil)
* [mobile](https://pkg.go.dev/github.com/hajimehoshi/ebiten/v2/mobile)
* [text](https://pkg.go.dev/github.com/hajimehoshi/ebiten/v2/text)
2014-12-27 15:27:37 +01:00
## Community
2021-05-14 05:20:08 +02:00
- [Discord](https://discord.gg/3tVdM5H8cC)
2021-03-30 03:32:01 +02:00
- `#ebiten` channel in [Gophers Slack](https://blog.gopheracademy.com/gophers-slack-community/)
- [GitHub Discussion](https://github.com/hajimehoshi/ebiten/discussions)
- [`r/ebiten` in Reddit](https://www.reddit.com/r/ebiten/)
2014-10-12 06:09:19 +02:00
## License
Ebiten is licensed under Apache license version 2.0. See [LICENSE](LICENSE) file.