README.md

Vuelto

A small CGo Game Engine that uses a custom Software Renderer.

Please note that vuelto is currently under high maintenance and is not production-ready. The project is actively being developed and improved, which is why there is only a main branch available. Also this project is not intended to be used in production. It's just a hobby project.

Building

Prerequisites

You need to have the following tools installed:

• Go
• C compiler
• SDL2

We have a installation guide here

Getting the Go package

Vuelto is an ordinary go package, so you can get it using this command:

go get github.com/dimkauzh/vuelto@latest

Example

We have a example located at example/example1/example.go

Running the Example

1. Open a terminal.

2. Clone the repo

git clone https://github.com/dimkauzh/vuelto.git

3. Navigate to the root directory of the vuelto project.

cd vertex

4. To run the example, use the following command:

go run example/example.go

Documentation

The documentation is available here. It will cover all of the api. We have the main documentation and the one that goes about the src folder which holds all the functions and methods. The main one is only to init and create a window

License

This project is licensed under the GPLv3 License - see the LICENSE file for details.