[](https://github.com/vuelto-org/vuelto)
[](https://github.com/vuelto-org/license)
[](https://github.com/vuelto-org/vuelto/actions/workflows/ci_check.yml)
[](https://github.com/vuelto-org/vuelto)
[](https://goreportcard.com/report/vuelto.pp.ua)
[](https://www.opengl.org/Documentation/Specs.html)
[](https://beua.today)
Vuelto is an open-source, fast, simple and lightweight game engine, based on Golang and OpenGL. Designed with simplicity and speed in mind, while still staying relatively lightweight. It can be deployed on almost all major platforms, including Linux, MacOS, Windows and Web.
> [!WARNING]
> This project has been discontinued by me. For this reason, the license becomes MIT. Feel free to do whatever you want with this project.
> [!NOTE]
> While Vuelto has a stable version, it's pretty much experimental software. Want something rock solid? Try [Ebitengine](https://github.com/hajimehoshi/ebiten)!
## β¨ Features
- π Cross Platform
- π οΈ Open-Source
- π Easy to learn
- π Fully built using CGo (and some other libraries)
## π¦ Installation
### π Requirements
You need to have the following installed on your system:
- π₯οΈ A C compiler (due to CGo)
- π§ A Go compiler (Go 1.23 and above)
- πͺ On Linux, Xorg/Wayland development packages
For an installation guide, [head over here](https://vuelto.pp.ua/install/).
### πΉ Go package
You can get the latest Go package by running this command:
```sh
go get vuelto.pp.ua@latest
```
## πΌοΈ Vuelto example
```go
package main
import (
vuelto "vuelto.pp.ua/pkg"
)
func main() {
w, _ := vuelto.NewWindow("Image Example - Vuelto", 800, 600, false)
ren := w.NewRenderer2D()
image, _ := ren.LoadImage("test/image.png", 0, 0, 0.5, 0.5)
for !w.Close() {
image.Draw()
w.Refresh()
}
}
```
## π₯οΈ Platform support
Vuelto has built-in deployment support for the following platforms:
| Platform | Status | Version |
| :---- | :---- | :---- |
| Windows | β
| v1.0 |
| macOS (Darwin) | β
| v1.0 |
| Linux | β
| v1.0 |
| Web | β
| v1.1 |
## π Docs
You can check out Vuelto's documentation at [Vuelto's website](https://vuelto.pp.ua/docs/).
> [!TIP]
> In case a part documentation is missing something or there is something wrong, use the [GoDoc](https://pkg.go.dev/vuelto.pp.ua) page for API documentation. Use the [examples](https://github.com/vuelto-org/vuelto/tree/stable/examples) directory for usage examples.
### π£οΈ Roadmap
Our roadmap is available on our [website](https://vuelto.pp.ua/roadmap/), under the Roadmap section.
### π€ Contributing
We're really thankful for your contributions! Please see our [Contributing Guide](contributing.md) for details.
1. π΄ Fork the repository
2. π Create your feature branch (`git checkout -b feature/amazing-feature`)
3. π Commit your changes (`git commit -m 'Add some amazing feature'`)
4. π Push to the branch (`git push origin feature/amazing-feature`)
5. π Open a Pull Request
## π‘οΈ Support & Security
### π Issues
See the [Issues](https://github.com/vuelto-org/vuelto/issues) page for current bugs and feature requests. In case you find any bug or have a suggestion, please open up an issue or search for any other form of contact to submit a bug report.
#### π Security Issues
If you find a security vulnerability, please follow the instructions in [security.md](security.md) to safely report it.
### π License
Vuelto is licensed under the [VL-Cv1.1 License](license.md). Any PRs that will change the license won't be accepted.
### π Guidelines
Weβre excited to have you here! To ensure a welcoming and productive environment, we kindly ask you to follow our **Guidelines**. Please take a moment to review the following:
- **[Contributing](contributing.md)**: Learn how to make meaningful contributions to our project.
- **[Code of Conduct](code_of_conduct.md)**: Understand the principles that foster a respectful and inclusive community.
### π Community and Contact
You can contact us via our Discord community or at our email:
- π¨οΈ [Discord server](https://vuelto.pp.ua/discord)
- βοΈ [Email](mailto:dima@vuelto.pp.ua)
### π Thanks To
A special thanks to:
- **Dimkauzh** for the initial idea and development.
- **ZakaMakesStuff** for the great improvements on top of vuelto.
Also a big shout-out to our homies and partners at [**Sokora**](https://sokora.org), [**Lumen**](https://atomlabs.ie) and [**Epic-Bot**](https://bamb.cl/epic-bot/)
Without the help of these people, Vuelto wouldn't be where it is today. Your support has helped make Vuelto even better! π€ π
---