Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
/luarocks
/lua
/lua_modules
/.luarocks
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
33 changes: 33 additions & 0 deletions sti-dev-1.rockspec
Original file line number Diff line number Diff line change
@@ -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",
}
}