Vuelto

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
• 🪟 Xorg/Wayland development packages (For Linux only)
• 🖱️ Supported platform

For an installation guide, go here.

🐹 Go package

You can get the latest Go package by running this command:

go get vuelto.pp.ua@latest

🖼️ Vuelto example

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", 300, 300, 250, 250)
	image1 := ren.LoadImage("test/image.png", 100, 100, 150, 150)

	for !w.Close() {
		image.Draw()
		image1.Draw()
		w.Refresh()
	}
}

🖥️ Platform support

Vuelto has built-in deployment support for the following platforms:

Platform	Status
Windows	✅
macOS (Darwin)	✅
Linux	✅
Web	❌ (Work In Progress, V1.1)

📖 Docs

You can check out Vuelto's documentation at Vuelto's website.

Tip

In case the documentation is missing something or there is something wrong, use the GoDoc page for API documentation. Use the examples directory for usage examples.

🛣️ Roadmap

Our roadmap is available on our website.

🤝 Contributing

We're really thankful for your contributions! Please see our Contributing Guide 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 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 to safely report it.

🔐 License

Vuelto is licensed under the VL-Cv1.1 Licence. 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: Learn how to make meaningful contributions to our project.
• Code of Conduct: 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
• ✉️ Email

🙌 Thanks To

A special thanks to:

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

Without your help, Vuelto wouldn't be where it is today. 🙌

Also a big shoutout to our homies and partners at Sokora and Atom Bot.

Your support has helped make Vuelto even better! 🤝

---

Made with ❤️ by the Vuelto Team