mat007 / ebitenui

User interface engine and widget library for Ebiten

Ebiten UI

A user interface engine and widget library for Ebitengine

>> Note: This library is separate from Ebitengine. Please reach out to the linked Discord server for questions or suggestions

Ebiten UI is an extension to Ebitengine that provides the ability to render a complete user interface, with widgets such as buttons, lists, combo boxes, and so on. It uses the [retained mode] model. All graphics used by Ebiten UI can be fully customized, so you can really make your UI your own.

Documentation on how to use and extend Ebiten UI is available at ebitenui.github.io.

Quick Start

Ebiten UI is written in Go 1.19 which is available at https://go.dev/.

There are Ebiten UI examples that can be found in the _examples/ folder.

They can be run from the root directory of the project with the following commands:

• Ebiten UI complete demo: go run github.com/ebitenui/ebitenui/_examples/demo
• Ebiten UI widget: go run github.com/ebitenui/ebitenui/_examples/widget_demos/<folder_name>

The examples can also be tested as WASM by running the following commands and opening your browser to http://localhost:6262:

• Ebiten UI complete demo: go run github.com/hajimehoshi/wasmserve@latest -http=:6262 ./_examples/demo
• Ebiten UI widget: go run github.com/hajimehoshi/wasmserve@latest -http=:6262 ./_examples/widget_demos/<folder_name>

Used By

• Roboden by quasilyte
• BANKWAVE: Neon Networth by Frabjous Studios
• Networked Game by Nmorenor
• Sinecord by quasilyte
• Cavebots by quasilyte

Social Media

• Discord

• Reddit

License

Ebiten UI is licensed under the MIT license.

Maintainers

• Currently maintained by Mark Carpenter [email protected]
• Originally written by Maik Schreiber [email protected]

Contributing

Want to help develop Ebiten UI? Check out our current issues. Want to know the steps on how to start contributing, take a look at the open source guide.