1414codeforge
/
gear
mirror of https://codeberg.org/1414codeforge/gear.git
1
0
Fork 0
Code Packages Projects Releases Activity
This is a read only mirror of the gear main repository.
2 Commits 1 Branch 0 Tags 78 KiB
Lua 100%
Go to file
Lorenzo Cogotti e658ba45c7 [df-utils] Remove rockspec, unnecessary for LÖVE-specific library. 2022-08-16 00:05:59 +02:00
spec [*] Initial commit. 2022-08-12 17:27:11 +02:00
.gitignore [*] Initial commit. 2022-08-12 17:27:11 +02:00
LICENSE [*] Initial commit. 2022-08-12 17:27:11 +02:00
README.md [*] Initial commit. 2022-08-12 17:27:11 +02:00
init.lua [*] Initial commit. 2022-08-12 17:27:11 +02:00

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.