diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..0771553 --- /dev/null +++ b/.gitignore @@ -0,0 +1,4 @@ +/luarocks +/lua +/lua_modules +/.luarocks diff --git a/README.md b/README.md index c1be91c..e802246 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,20 @@ If you like STI, consider tossing me a few monies via [**PayPal**][paypal]. Simple Tiled Implementation is a [**Tiled**][Tiled] map loader and renderer designed for the *awesome* [**LÖVE**][LOVE] framework. Please read the [**documentation**][dox] to learn how it works, or check out the tutorials included in this repo. +## Installation With LuaRocks + +STI can be installed via LuaRocks: + +```sh +luarocks install --server=https://luarocks.org/dev sti +``` + +You can also install directly from the rockspec file: + +```sh +luarocks install sti-dev-1.rockspec +``` + ## Quick Example ```lua diff --git a/sti-dev-1.rockspec b/sti-dev-1.rockspec new file mode 100644 index 0000000..91ed74d --- /dev/null +++ b/sti-dev-1.rockspec @@ -0,0 +1,33 @@ +package = "sti" +version = "dev-1" +source = { + url = "git+https://github.com/karai17/Simple-Tiled-Implementation.git" +} +description = { + summary = "Tiled library for LÖVE", + detailed = [[ + Simple Tiled Implementation (STI) is a Tiled map loader and renderer + designed for the LÖVE framework. It supports loading Tiled maps exported + to Lua format and provides features like animated tiles, custom layers, + object layers, and plugins for physics engines (Box2D, bump.lua). + ]], + homepage = "https://github.com/karai17/Simple-Tiled-Implementation", + license = "MIT/X11" +} +dependencies = { + "lua >= 5.1" +} +build = { + type = "builtin", + modules = { + ["sti"] = "sti/init.lua", + ["sti.atlas"] = "sti/atlas.lua", + ["sti.graphics"] = "sti/graphics.lua", + ["sti.utils"] = "sti/utils.lua", + ["sti.plugins.box2d"] = "sti/plugins/box2d.lua", + ["sti.plugins.bump"] = "sti/plugins/bump.lua", + }, + copy_directories = { + "doc", + } +}