Set of Lua libraries to make game development easier using the LÖVE game framework.
+ +See main module for more information, or the GitHub page for the source.
+ +| init | +Ubiquitousse main module. | +
| ldtk | +LDtk level importer for LÖVE. | +
| README.md | ++ |
| LICENSE | ++ |
initUbiquitousse main module.
+Set of various Lua libraries to make game development easier, mainly made to be used alongside the LÖVE game framework. + Nothing that hasn’t been done before, but these are tailored to what I need. They can be used independently too, and are relatively portable, even without LÖVE.
+ +This is the main module, which will try to load every other Ubiquitousse module when required and may even provide a few convenience functions.
+ +This also perform a quick LÖVE version check and show a warning in case of potential incompatibility.
+ +Regarding Ubiquitousse’s organization
+ +Ubiquitousse may or may not be used in its totality. You can delete the modules directories you don’t need and Ubiquitousse + should adapt accordingly. You can also simply copy the modules directories you need and use them directly, without using this + file at all. + However, some modules may provide more feature when other modules are available. + These dependencies are written at the top of every main module file.
+ + Ubiquitousse’s original goal was to run everywhere with the least porting effort possible, so while the current version now mainly focus LÖVE, it
+ should still be easily modifiable to work with something else. Ubiquitousse is mainly tested on LuaJIT and Lua 5.3 but should also support Lua 5.1 and 5.2.
+ In order to keep a good idea of how portable this all is, other dependencies, including LÖVE, are explicited at the top of every module file and in specific
+ functions definition using the @require tag (e.g., — @require love for LÖVE).
Some modules are developped in Candran (.can files), but can easily be compiled into regular Lua code.
+ +Units used in the API documentation, unless written otherwise:
+ +These units are only used to make writing documentation easier; you can use other units if you want, as long as you're consistent.
+ +Style:
+ +Regarding the documentation: Ubiquitousse used LDoc/LuaDoc styled-comments, but since LDoc hates me and my code, the + generated result is complete garbage, so please read the documentation directly in the comments here until fix this. + Stuff you're interested in starts with triple – (e.g., “—– This functions saves the world”).
+ +UPDATE: I give up, currently in the process of admitting defat to LDoc and progressively porting all my documentation to it. + Though I had to modify a few things to get LDoc to like me, so the documentation is generated using my LDoc fork.
+local ubiquitousse = require("ubiquitousse")
+
+
+
+
+
+ "0.1.0").
+
+
+
+
+
+
+
+
+ldtkLDtk level importer for LÖVE.
+Support most LDtk features, and allow easy usage in LÖVE projects.
+ +Every unit is in pixel in the API unless written otherwise.
+ +This modules returns a single function LDtk(path).
+ + Requires LÖVE love.graphics (drawing Image, SpriteBatch, Quad).
local ldtk = require("ubiquitousse.ldtk")
+
+local project = ltdk("example.ldtk")
+
+local callbacks = {
+ onAddEntity = function(entity)
+ -- handle entity...
+ end
+}
+
+-- load every level
+for _, lvl in ipairs(project.levels) do lvl:load() end
+
+function love.draw()
+ -- draw every level
+ for _, lvl in ipairs(project.levels) do lvl:draw() end
+end
+
+
+
+
+
+ Part of a Level. +
This represent the tiles from a Tiles, AutoLayer or IntGrid with AutoLayer rules layer.
+ + Can be retrived from the tiles list or onAddTile level load callback.
+
This represent the tiles from a IntGrid without AutoLayer rules layer.
+ + Can be retrived from the intTiles list or onAddIntTile level load callback.
+
This represent an entity from an Entities layer.
+ + Can be retrived from the entities list or onAddEntity level load callback.
+
By default, this draws the tile associated with the entity if there is one, or a rectangle around the entity position otherwise. + +
Levels are not automatically loaded in order to not waste ressources if your project is large; so before drawing or operating on a level, you will need to call its Level:load method.
+ +Part of a Project. +
You can optionally specify some callbacks for the loading process:
+ +onAddLayer(layer) will be called for every new layer loaded, with the Layer as sole argumentonAddTile(tile) will be called for every new tile loaded, with the Tile as sole argumentonAddIntTile(tile) will be called for every new IntGrid tile loaded, with the IntTile as sole argumentonAddEntity(entity) will be called for every new entity loaded, with the Entity as sole argumentThese callbacks should allow you to capture all the important elements needed to use the level, so you can hopefully + integrate it into your current game engine easily. + +
Unload the level. + Images loaded by the level will be freed on the next garbage collection cycle.
+ +You can optionally specify some callbacks for the unloading process:
+ +onAddLayer(layer) will be called for every new layer unloaded, with the Layer as sole argumentonAddTile(tile) will be called for every new tile unloaded, with the Tile as sole argumentonAddIntTile(tile) will be called for every new IntGrid tile unloaded, with the IntTile as sole argumentonAddEntity(entity) will be called for every new entity unloaded, with the Entity as sole argumentReturned by LDtk. +
ubiquitousse.ldtk returns a single function, LDtk.
+ Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
+ +THE SOFTWARE IS PROVIDED “AS IS” AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. + +
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.
+ +Documentation is done in LDoc-like comments in source files, but LDoc doesn’t really like how I structure my libraries so you can’t really generate documentation with it. I'm currently trying to fix this; some modules already have a working LDoc documentation in doc/.
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).
+ + +