# Goblocks

Lua game engine based on Raylib

## Important Links:
- [References](#references)
- [Installation](#installation)

## Project Structure

Goblocks uses Lua for projects.

The most basic project would look like this:

```lua
function Setup()
end

function Update(dt)
end

function Draw()
    hello()
end
```

All of those functions are required for a window to open!

## Installation

If you have [Cargo](https://github.com/rust-lang/cargo) installed simply run `cargo install goblocks` in your shell/prompt.

## References

### Out of this project

Raylib - [Github](https://github.com/raysan5/raylib) [Website](https://www.raylib.com/index.html)

Lua - [Github](https://github.com/lua/lua) [Website](https://www.lua.org/)

### In this project

Documentation - [File](./DOCS.md)

Features - [File](./FEATURES.md)

Examples - [File](./EXAMPLES.MD)