2022-08-16 00:16:17 +02:00
|
|
|
gear - The LÖVE Utility Gear
|
|
|
|
|
============================
|
2022-08-12 17:21:42 +02:00
|
|
|
|
2022-08-16 00:16:17 +02:00
|
|
|
**gear** provides common functionality for
|
2022-08-12 17:21:42 +02:00
|
|
|
[LÖVE](https://love2d.org) game development, including:
|
|
|
|
|
|
|
|
|
|
* 2D vector algebra
|
|
|
|
|
* Minimal 3D vector algebra
|
|
|
|
|
* 2D bounds (axis-aligned rectangles)
|
|
|
|
|
* General utility math functions
|
2022-08-16 00:16:17 +02:00
|
|
|
* Common stateless algorithms
|
2022-08-12 17:21:42 +02:00
|
|
|
|
|
|
|
|
Code is reasonably biased towards speed, at the occasional
|
|
|
|
|
expense of abstraction.
|
|
|
|
|
|
|
|
|
|
Documentation
|
|
|
|
|
=============
|
|
|
|
|
|
|
|
|
|
Code is documented with [LDoc](https://github.com/lunarmodules/LDoc).
|
|
|
|
|
|
|
|
|
|
Documentation may be generated running the command:
|
|
|
|
|
|
|
|
|
|
```sh
|
2022-09-01 09:02:20 +02:00
|
|
|
ldoc .
|
2022-08-12 17:21:42 +02:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
`ldoc` generates a `doc` directory, open `doc/index.html`
|
|
|
|
|
with your favorite browser to read the documentation.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Test suite
|
|
|
|
|
==========
|
|
|
|
|
|
|
|
|
|
The test suite uses [busted](https://olivinelabs.com/busted/).
|
|
|
|
|
|
|
|
|
|
Tests may be run with the command:
|
|
|
|
|
|
|
|
|
|
```sh
|
|
|
|
|
lua spec/utils_spec.lua
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
License
|
|
|
|
|
=======
|
|
|
|
|
|
|
|
|
|
See [LICENSE](LICENSE) for details.
|
