summaryrefslogtreecommitdiff
path: root/README.md
blob: d10f06d3b8b961577d89c7e606df20add035dab8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
```
 ▄▄ • ▄• ▄▌ ▐ ▄ .▄▄ · ▄▄▄▄▄ ▄▄▄·  ▄▄· ▄ •▄
▐█ ▀ ▪█▪██▌•█▌▐█▐█ ▀. •██  ▐█ ▀█ ▐█ ▌▪█▌▄▌▪
▄█ ▀█▄█▌▐█▌▐█▐▐▌▄▀▀▀█▄ ▐█.▪▄█▀▀█ ██ ▄▄▐▀▀▄·
▐█▄▪▐█▐█▄█▌██▐█▌▐█▄▪▐█ ▐█▌·▐█ ▪▐▌▐███▌▐█.█▌
·▀▀▀▀  ▀▀▀ ▀▀ █▪ ▀▀▀▀  ▀▀▀  ▀  ▀ ·▀▀▀ ·▀  ▀
```

Collection of modular and minimal libraries used by our games. These libraries are designed to be
"vendored in" aka. copy-and-pasted into a project's folder. Some libraries may depend on each other,
but most can be used in isolation. Each library should contain a license in the header.

Use at your own risk.

| Name   | Description                                |
| ------ | ------------------------------------------ |
| Peak   | Single-header platform library that automatically links the write system libraries. |
| Draw   | Simple RGBA software raster                |
| Math   | Math for games. Speed over precision.|
| Poof   | Build software without going insane.       |
| Rend   | Modern graphics API layer.                 |
| Cool   | Render HTML by calling functions.          |

## Maturity & Versioning

Most libraries include a version and a change log at the top of the file.
This is helpful if you decide to update one of the libraries you are using in a project.
Libraries that have reached or surpassed the 1.0.0 landmark are generally considered
to be "completed."

## Documentation

Documentation can be found on [godgun.net](https://godgun.net/docs) (results may vary).
We recommend just reading the header files. It's all there.