This is a read only mirror of the gear main repository.
Go to file
Lorenzo Cogotti 32cecbef1c [rect] Make rotatesincos() require() path safer. 2022-09-01 08:57:35 +02:00
spec [spec/utils_spec.lua] Remove obsolete test. 2022-08-16 00:10:44 +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.ACKNOWLEDGEMENT [signal,timer,init] Add customized versions of signal and timer from vrld/hump. 2022-08-16 10:38:33 +02:00
README.md [README] Update README. 2022-08-16 00:16:17 +02:00
algo.lua [algo] Improve documentation. 2022-09-01 08:52:02 +02:00
config.ld [config.ld] Add ldoc config.ld to project. 2022-09-01 08:27:57 +02:00
init.lua [init] Fix signal and timer entries, capitalize them since they are classes. 2022-08-16 11:19:39 +02:00
meta.lua [meta] Improve documentation. 2022-09-01 08:28:59 +02:00
rect.lua [rect] Make rotatesincos() require() path safer. 2022-09-01 08:57:35 +02:00
shadowtext.lua [shadowtext] Add text with drop shadow utilities. 2022-08-16 00:15:50 +02:00
signal.lua [signal,timer,init] Add customized versions of signal and timer from vrld/hump. 2022-08-16 10:38:33 +02:00
strings.lua [strings] Add file header. 2022-09-01 08:29:50 +02:00
timer.lua [signal,timer,init] Add customized versions of signal and timer from vrld/hump. 2022-08-16 10:38:33 +02:00
vec.lua [spec/*,*] Split library in submodules. 2022-08-16 00:10:09 +02:00

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.