Looking for plugin devs to add features to STI
Posted: Fri Sep 25, 2015 9:53 am
Yo! As many of you already know, I am the developer of Simple Tiled Implementation, a fast and simple Tiled map loader and renderer. I've recently added a very simple plugin system that allows people to extend STI by adding features that probably don't belong in STI proper. For the first plugin, I moved my Box2D processing code out of STI and into a plugin.
And this is where my request comes in. I don't really have much time to work on extending STI, nor do I have extensive knowledge of other libraries that STI should interface with. If anyone out there has used STI, knows how it works, and would like to help extend it, I am looking for, at minimum, the following plugins:
Creating a plugin for STI is pretty simple. You just need to return a table with functions and/or properties, preferably namespaced, and you're done! Functions need to have the map as the first argument!
I'm not going to be too picky about code style, but if you want to match STI's style, I use tabs to indent, and spaces to align. I also like to align = signs in code blocks. See below for an example of how I would write a plugin.
If anyone is up to the task, please let me know! My only stipulation is that the plugin MUST be licensed under the MIT/X11 license (or a compatible license such as BSD-2-Clause), otherwise I cannot include it with STI. You're welcome to credit yourself in the plugin file and all that jazz, it's your code after all!
And this is where my request comes in. I don't really have much time to work on extending STI, nor do I have extensive knowledge of other libraries that STI should interface with. If anyone out there has used STI, knows how it works, and would like to help extend it, I am looking for, at minimum, the following plugins:
- bump.lua interface - DONE!
- HC interface
- Light World interface
- Convert Tile Collections to a Tile Atlas
Creating a plugin for STI is pretty simple. You just need to return a table with functions and/or properties, preferably namespaced, and you're done! Functions need to have the map as the first argument!
I'm not going to be too picky about code style, but if you want to match STI's style, I use tabs to indent, and spaces to align. I also like to align = signs in code blocks. See below for an example of how I would write a plugin.
Code: Select all
--- Bump plugin for STI
-- @module bump
-- @author Someone Cool
-- @copyright 2015
-- @license MIT/X11
return {
bump_LICENSE = "MIT/X11",
bump_URL = "https://github.com/someonecool/bump_sti_plugin",
bump_VERSION = "3.1.5.0", -- semantic versioning, this implies that it should work with bump 3.1.5 and has not yet been revised.
bump_DESCRIPTION = "Box2D hooks for STI.",
bump_init = function(map, arg1, arg2)
-- some init code!
end,
bump_draw = function(map)
-- draw code!
end
}