This is a read only mirror of the gear main repository.
Go to file
Lorenzo Cogotti 37779954f9 [mathx,init] Add math utilities 2024-01-26 16:25:08 +01: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
.luarc.json [.luarc] Add lua-language-server config file. 2023-11-21 12:08:10 +01:00
LICENSE [*] Initial commit. 2022-08-12 17:27:11 +02:00
README.ACKNOWLEDGEMENT [README,camera] Add camera management module. 2023-06-01 23:12:20 +02:00
README.md [README] Update ldoc usage. 2022-09-01 09:02:20 +02:00
algo.lua [algo] Add sign() function 2023-11-01 11:21:02 +01:00
camera.lua [README,camera] Add camera management module. 2023-06-01 23:12:20 +02:00
color.lua [color] Add helper functions for HSV and HSL color conversion 2024-01-26 16:23:55 +01:00
config.ld [config.ld] Add ldoc config.ld to project. 2022-09-01 08:27:57 +02:00
init.lua [mathx,init] Add math utilities 2024-01-26 16:25:08 +01:00
mathx.lua [mathx,init] Add math utilities 2024-01-26 16:25:08 +01: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 utility to test whether a path is absolute 2023-09-23 16:03:12 +02:00
timer.lua [timer] Minor style fix 2024-01-26 16:24:30 +01:00
vec.lua [vec] Add 2D cross product 2023-11-21 11:26:52 +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.