zorldo

Goofing around with Ebiten
git clone git://bsandro.tech/zorldo
Log | Files | Refs | README

README.md (2892B)

      1 # Ebiten (v2)
      2 
      3 [![Go Reference](https://pkg.go.dev/badge/github.com/hajimehoshi/ebiten/v2.svg)](https://pkg.go.dev/github.com/hajimehoshi/ebiten/v2)
      4 [![Build Status](https://github.com/hajimehoshi/ebiten/workflows/test/badge.svg)](https://github.com/hajimehoshi/ebiten/actions?query=workflow%3Atest)
      5 [![Go Report Card](https://goreportcard.com/badge/github.com/hajimehoshi/ebiten)](https://goreportcard.com/report/github.com/hajimehoshi/ebiten)
      6 
      7 **A dead simple 2D game library for Go**
      8 
      9 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.
     10 
     11 * [Website (ebiten.org)](https://ebiten.org)
     12 * [API Reference](https://pkg.go.dev/github.com/hajimehoshi/ebiten/v2)
     13 * [Cheat Sheet](https://ebiten.org/documents/cheatsheet.html)
     14 
     15 ![Overview](https://ebiten.org/images/overview2.2.png)
     16 
     17 ## Platforms
     18 
     19 * [Windows](https://ebiten.org/documents/install.html?os=windows) (No Cgo!)
     20 * [macOS](https://ebiten.org/documents/install.html?os=darwin)
     21 * [Linux](https://ebiten.org/documents/install.html?os=linux)
     22 * [FreeBSD](https://ebiten.org/documents/install.html?os=freebsd)
     23 * [Android](https://ebiten.org/documents/mobile.html)
     24 * [iOS](https://ebiten.org/documents/mobile.html)
     25 * [WebAssembly](https://ebiten.org/documents/webassembly.html)
     26 * Nintendo Switch™
     27 
     28 Note: Gamepads and keyboards are not available on iOS.
     29 
     30 For installation on desktops, see [the installation instruction](https://ebiten.org/documents/install.html).
     31 
     32 ## Features
     33 
     34 * 2D Graphics (Geometry and color transformation by matrices, Various composition modes, Offscreen rendering, Text rendering, Automatic batches, Automatic texture atlas, Custom shaders)
     35 * Input (Mouse, Keyboard, Gamepads, Touches)
     36 * Audio (Ogg/Vorbis, MP3, WAV, PCM)
     37 
     38 ## Packages
     39 
     40 * [ebiten](https://pkg.go.dev/github.com/hajimehoshi/ebiten/v2)
     41   * [audio](https://pkg.go.dev/github.com/hajimehoshi/ebiten/v2/audio)
     42     * [mp3](https://pkg.go.dev/github.com/hajimehoshi/ebiten/v2/audio/mp3)
     43     * [vorbis](https://pkg.go.dev/github.com/hajimehoshi/ebiten/v2/audio/vorbis)
     44     * [wav](https://pkg.go.dev/github.com/hajimehoshi/ebiten/v2/audio/wav)
     45   * [ebitenutil](https://pkg.go.dev/github.com/hajimehoshi/ebiten/v2/ebitenutil)
     46   * [inpututil](https://pkg.go.dev/github.com/hajimehoshi/ebiten/v2/inpututil)
     47   * [mobile](https://pkg.go.dev/github.com/hajimehoshi/ebiten/v2/mobile)
     48   * [text](https://pkg.go.dev/github.com/hajimehoshi/ebiten/v2/text)
     49 
     50 ## Community
     51 
     52 - [Discord](https://discord.gg/3tVdM5H8cC)
     53 - `#ebiten` channel in [Gophers Slack](https://blog.gopheracademy.com/gophers-slack-community/)
     54 - [GitHub Discussion](https://github.com/hajimehoshi/ebiten/discussions)
     55 - [`r/ebiten` in Reddit](https://www.reddit.com/r/ebiten/)
     56 
     57 ## License
     58 
     59 Ebiten is licensed under Apache license version 2.0. See [LICENSE](LICENSE) file.