Home
Welcome to the Vuelto website! Here you will find things like documentation, blogs, tutorials and everything about Vuelto!
âšī¸ About¶
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.
đš Go package¶
You can get the latest Go package by running this command:
đĨī¸ 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.
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 the website (URL here) or in the ROADMAP.md file in the root of the GitHub repo.
đ¤ Contributing¶
We're really thankful for your contributions! Please see our Contributing Guide for details.
- đ´ Fork the repository
- đ Create your feature branch (
git checkout -b feature/amazing-feature) - đ Commit your changes (
git commit -m 'Add some amazing feature') - đ Push to the branch (
git push origin feature/amazing-feature) - đ Open a Pull Request
đĄī¸ Support & Security¶
đ Issues¶
See the Issues page for current bugs and feature requests. In case you find any issues, please open 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 License. Any PRs that primarily focus on changing the license won't be accepted.
âšī¸ About¶
All of our contact info, project info and our team/partners can be found on the About page.