Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/vuelto-org/vuelto

A fast and lightweight game engine powered by Go and OpenGL.
https://github.com/vuelto-org/vuelto

engine game game-development game-engine go go-game go-game-engine golang legacy-opengl library open-source opengl

Last synced: about 15 hours ago
JSON representation

A fast and lightweight game engine powered by Go and OpenGL.

Awesome Lists containing this project

README

        


banner
banner
GitHub last commit
License

CI Check

Lines of code
Report card
Powered By
Powered By

Vuelto is an open-source, fast, and lightweight game engine, based on Golang, CGo, and OpenGL. It's easy to use yet very powerful, and it's also cross platform, meaning it can be deployed on almost all major platforms.

## ✨ 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
- πŸ”§ A Go compiler (Go 1.18 and above)
- πŸͺŸ Xorg/Wayland development packages (For Linux only)
- πŸ–±οΈ Supported platform

For an installation guide, [go 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 the 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/latest/examples) directory for usage examples.

### πŸ›£οΈ Roadmap

Our roadmap is available on our [website](https://vuelto.pp.ua/roadmap/).

### 🀝 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:[email protected])

### πŸ™Œ Thanks To

A special thanks to:

- **Dimkauzh** for the initial idea and development.
- **ZakaHaceCosas** for the great improvements on top of vuelto.

Also a big shoutout to our homies and partners at [**Sokora**](https://sokora.org), [**Atom**](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! 🀝 πŸ™Œ

---

Made with ❀️ by the Vuelto Team