This is a read only mirror of the gear main repository.
Go to file
Lorenzo Cogotti 2959abc4f6 [timer] Rework new() consistently with other classes. 2023-06-01 22:46:39 +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 ldoc usage. 2022-09-01 09:02:20 +02:00
algo.lua [algo] Add stable sort algorithm, using merge sort. 2023-06-01 22:44:27 +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 isinstance(). 2022-11-06 17:32:55 +01: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] Fix module name and summary. 2023-06-01 22:41:47 +02:00
strings.lua [strings] Add path utility functions, improve documentation. 2022-10-02 14:40:30 +02:00
timer.lua [timer] Rework new() consistently with other classes. 2023-06-01 22:46:39 +02:00
vec.lua [vec] Fix sqrdist* functions. 2023-03-04 08:32:16 +01: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 .

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.