ebiten/README.md

65 lines
3.2 KiB
Markdown
Raw Normal View History

2022-05-25 15:48:19 +02:00
# Ebitengine (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-04-19 16:30:02 +02:00
2022-09-19 17:28:45 +02:00
**A dead simple 2D game engine for Go**
2019-03-21 17:27:01 +01:00
2022-09-19 17:28:45 +02:00
Ebitengine (formerly known as Ebiten) is an open source game engine for the Go programming language. Ebitengine'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
* [Website (ebitengine.org)](https://ebitengine.org)
2020-10-03 22:07:08 +02:00
* [API Reference](https://pkg.go.dev/github.com/hajimehoshi/ebiten/v2)
* [Cheat Sheet](https://ebitengine.org/en/documents/cheatsheet.html)
2022-06-23 04:27:29 +02:00
* [Awesome Ebitengine](https://github.com/sedyh/awesome-ebitengine)
2018-02-19 18:21:37 +01:00
![Overview](https://ebitengine.org/images/overview2.png)
2019-11-02 09:38:01 +01:00
2018-02-19 18:21:37 +01:00
## Platforms
2023-02-05 06:06:58 +01:00
* [Windows](https://ebitengine.org/en/documents/install.html?os=windows) (No Cgo required!)
* [macOS](https://ebitengine.org/en/documents/install.html?os=darwin)
* [Linux](https://ebitengine.org/en/documents/install.html?os=linux)
* [FreeBSD](https://ebitengine.org/en/documents/install.html?os=freebsd)
* [Android](https://ebitengine.org/en/documents/mobile.html)
* [iOS](https://ebitengine.org/en/documents/mobile.html)
* [WebAssembly](https://ebitengine.org/en/documents/webassembly.html)
2023-02-23 15:23:12 +01:00
* Nintendo Switch
* Xbox
2014-10-12 06:09:19 +02:00
2021-12-05 16:24:55 +01:00
Note: External (bluetooth) keyboards are not available on iOS yet.
2016-11-26 16:11:23 +01:00
For installation on desktops, see [the installation instruction](https://ebitengine.org/en/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)
2022-11-08 15:52:36 +01:00
* [colorm](https://pkg.go.dev/github.com/hajimehoshi/ebiten/v2/colorm)
2020-10-03 22:07:08 +02:00
* [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)
2022-04-12 15:22:57 +02:00
* [vector](https://pkg.go.dev/github.com/hajimehoshi/ebiten/v2/vector)
2014-12-27 15:27:37 +01:00
## Community
2021-05-14 05:20:08 +02:00
- [Discord](https://discord.gg/3tVdM5H8cC)
- `#ebitengine` channel in [Gophers Slack](https://blog.gopheracademy.com/gophers-slack-community/)
2021-03-30 03:32:01 +02:00
- [GitHub Discussion](https://github.com/hajimehoshi/ebiten/discussions)
2022-08-27 06:53:06 +02:00
- [`r/ebitengine` in Reddit](https://www.reddit.com/r/ebitengine/)
2014-10-12 06:09:19 +02:00
## License
2022-05-25 15:48:19 +02:00
Ebitengine is licensed under Apache license version 2.0. See [LICENSE](LICENSE) file.
2022-01-26 17:02:43 +01:00
[The Ebitengine logo](https://ebitengine.org/images/logo.png) by Hajime Hoshi is licensed under [the Creative Commons Attribution-NoDerivatives 4.0](https://creativecommons.org/licenses/by-nd/4.0/).