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 0ce17379a1 [algo] Improve documentation. 2 years ago
spec [spec/utils_spec.lua] Remove obsolete test. 2 years ago
.gitignore [*] Initial commit. 2 years ago
LICENSE [*] Initial commit. 2 years ago
README.ACKNOWLEDGEMENT [signal,timer,init] Add customized versions of signal and timer from vrld/hump. 2 years ago
README.md [README] Update README. 2 years ago
algo.lua [algo] Improve documentation. 2 years ago
config.ld [config.ld] Add ldoc config.ld to project. 2 years ago
init.lua [init] Fix signal and timer entries, capitalize them since they are classes. 2 years ago
meta.lua [meta] Improve documentation. 2 years ago
rect.lua [rect] Fix variables name. 2 years ago
shadowtext.lua [shadowtext] Add text with drop shadow utilities. 2 years ago
signal.lua [signal,timer,init] Add customized versions of signal and timer from vrld/hump. 2 years ago
strings.lua [strings] Add file header. 2 years ago
timer.lua [signal,timer,init] Add customized versions of signal and timer from vrld/hump. 2 years ago
vec.lua [spec/*,*] Split library in submodules. 2 years ago

README.md

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 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.