1
0
Fork 0
mirror of https://github.com/Reuh/ubiquitousse.git synced 2025-10-27 09:09:30 +00:00

Update README

This commit is contained in:
Étienne Fildadut 2022-09-16 19:36:54 +09:00
parent 432ce84fbe
commit 9ea7241f58
2 changed files with 15 additions and 3 deletions

View file

@ -1,6 +1,18 @@
# ubiquitousse # ubiquitousse
Set of various libraries I use for game development, mainly with LÖVE. Nothing that hasn't been done before, but these are tailored to what I need. They can be used independently too. Set of various libraries I use for game development, mainly with LÖVE. Most of which has already been done before, but these are tailored to what I need. They can be used independently too (you should be able to only pick the directories of the libraries you need; some modules depends on each other though, see documentation for details).
This provides, sorting the one with the fewest existing alterative as far as I know first:
* `ldtk` provides a [LDtk](https://ldtk.io/) level importer
* `gltf` provides a [glTF](https://www.khronos.org/gltf/) model loader
* `ecs` provides [ECS](https://en.wikipedia.org/wiki/Entity_component_system) facilities
* `input` provides input management facilities
* `timer` provides time management facilities
* `signal` provides a simple signal / observer pattern implementation
* `asset` provides barebones asset loading facilities
* `scene` provides some scene management facilities
* `util` provides some random, occasionally useful functions
You can find the documentation [here](https://reuh.github.io/ubiquitousse/index.html) or in the `docs/` directory. You can find the documentation [here](https://reuh.github.io/ubiquitousse/index.html) or in the `docs/` directory.
@ -8,4 +20,4 @@ Documentation is done in LDoc-like comments in source files, but LDoc doesn't re
Whatever is currently on the master branch should be working and usable. Changelog, including breaking changes, are documented in commit messages. Whatever is currently on the master branch should be working and usable. Changelog, including breaking changes, are documented in commit messages.
Licensed under ISC (equivalent to MIT/Expat/Simplified BSD). Licensed under ISC (equivalent to MIT/Expat/Simplified BSD). Have fun.

View file

@ -35,7 +35,7 @@ file = {
"init.lua", "init.lua",
"asset/asset.lua", "asset/asset.lua",
"ecs/ecs.can", "ecs/ecs.can",
-- TODO: input "input/input.lua",
"ldtk/ldtk.can", "ldtk/ldtk.can",
"scene/scene.lua", "scene/scene.lua",
"signal/signal.can", "signal/signal.can",