1414codeforge
/
gear
mirror of https://codeberg.org/1414codeforge/gear.git
1
0
Fork 0
Code Packages Projects Releases Activity
gear/README.md

891 B
Raw Permalink Blame History

gear - The LÖVE Utility Gear

gear provides common functionality for LÖVE game development, including:

  • 2D vector algebra
  • Minimal 3D vector algebra
  • 2D bounds (axis-aligned rectangles)
  • General utility math functions
  • Common stateless 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 .

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.