This is a read-only mirror of https://gitea.it/1414codeforge/gear. Please direct any pull-request, issue or discussion to the main repo.
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Lorenzo Cogotti 5c345d5e60 [*] Initial commit. 2 years ago
spec [*] Initial commit. 2 years ago
.gitignore [*] Initial commit. 2 years ago
LICENSE [*] Initial commit. 2 years ago
README.md [*] Initial commit. 2 years ago
df-utils-scm-1.rockspec [*] Initial commit. 2 years ago
init.lua [*] Initial commit. 2 years ago

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.