Lorenzo Cogotti 619d31bf2f | ||
---|---|---|
spec | ||
.gitignore | ||
LICENSE | ||
README.md | ||
algo.lua | ||
init.lua | ||
meta.lua | ||
rect.lua | ||
strings.lua | ||
vec.lua |
README.md
df-utils - LÖVE Utility Library
df-utils provides stateless functions for common LÖVE game development, including:
- 2D vector algebra
- Minimal 3D vector algebra
- 2D bounds (axis-aligned rectangles)
- General utility math functions
- Common algorithms
Code is reasonably biased towards speed, at the occasional expense of abstraction.
Documentation
Code is documented with LDoc.
Documentation may be generated running the command:
ldoc init.lua
ldoc
generates a doc
directory, open doc/index.html
with your favorite browser to read the documentation.
Test suite
The test suite uses busted.
Tests may be run with the command:
lua spec/utils_spec.lua
License
See LICENSE for details.