https://github.com/karai17/Simple-Tiled-Implementation

Tiled library for LÖVE
https://github.com/karai17/Simple-Tiled-Implementation

Last synced: 3 days ago
JSON representation

Tiled library for LÖVE

• Host: GitHub
• URL: https://github.com/karai17/Simple-Tiled-Implementation
• Owner: karai17
• License: other
• Created: 2014-01-14T17:09:48.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2024-03-24T11:43:23.000Z (8 months ago)
• Last Synced: 2024-08-02T06:17:39.637Z (3 months ago)
• Language: Lua
• Size: 2.15 MB
• Stars: 826
• Watchers: 30
• Forks: 121
• Open Issues: 25
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

• awesome-love2d - Simple Tiled Implementation - Tiled map loader and renderer. (Helpers)

README

        
# Simple Tiled Implementation

[![Join the chat at https://gitter.im/karai17/Simple-Tiled-Implementation](https://badges.gitter.im/karai17/Simple-Tiled-Implementation.svg)](https://gitter.im/karai17/Simple-Tiled-Implementation?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

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.

## Quick Example

```lua

-- This example uses the included Box2D (love.physics) plugin!!

local sti = require "sti"

function love.load()

	-- Grab window size

	windowWidth  = love.graphics.getWidth()

	windowHeight = love.graphics.getHeight()

	-- Set world meter size (in pixels)

	love.physics.setMeter(32)

	-- Load a map exported to Lua from Tiled

	map = sti("assets/maps/map01.lua", { "box2d" })

	-- Prepare physics world with horizontal and vertical gravity

	world = love.physics.newWorld(0, 0)

	-- Prepare collision objects

	map:box2d_init(world)

	-- Create a Custom Layer

	map:addCustomLayer("Sprite Layer", 3)

	-- Add data to Custom Layer

	local spriteLayer = map.layers["Sprite Layer"]

	spriteLayer.sprites = {

		player = {

			image = love.graphics.newImage("assets/sprites/player.png"),

			x = 64,

			y = 64,

			r = 0,

		}

	}

	-- Update callback for Custom Layer

	function spriteLayer:update(dt)

		for _, sprite in pairs(self.sprites) do

			sprite.r = sprite.r + math.rad(90 * dt)

		end

	end

	-- Draw callback for Custom Layer

	function spriteLayer:draw()

		for _, sprite in pairs(self.sprites) do

			local x = math.floor(sprite.x)

			local y = math.floor(sprite.y)

			local r = sprite.r

			love.graphics.draw(sprite.image, x, y, r)

		end

	end

end

function love.update(dt)

	map:update(dt)

end

function love.draw()

	-- Draw the map and all objects within

	love.graphics.setColor(1, 1, 1)

	map:draw()

	-- Draw Collision Map (useful for debugging)

	love.graphics.setColor(1, 0, 0)

	map:box2d_draw()

	-- Please note that map:draw, map:box2d_draw, and map:bump_draw take

	-- translate and scale arguments (tx, ty, sx, sy) for when you want to

	-- grow, shrink, or reposition your map on screen.

end

```

## Requirements

This library recommends LÖVE 11.x and Tiled 1.2.x. If you are updating from an older version of Tiled, please re-export your Lua map files.

## License

This code is licensed under the [**MIT/X11 Open Source License**][MIT]. Check out the LICENSE file for more information.

[Tiled]: http://www.mapeditor.org/

[LOVE]: https://www.love2d.org/

[dox]: http://karai17.github.io/Simple-Tiled-Implementation/

[MIT]: http://www.opensource.org/licenses/mit-license.html

[paypal]: https://www.paypal.me/LandonManning