README.md

LuaPill

LuaPill (short for "Practical Isometric Layering Library") is an engine for generating isometric maps for Löve2D and Lua. See Example for usage, or try one of the demos. Just git clone the repository and run love demo/editor.

Example

function love.load()
   map = require "luapill"
   local config = {
      tilewidth = 128,
      tileheight = 64,
      folder = "images"
   }
   map:setup(config)
end

function love.update(dt)
end

function love.draw()
   map:draw()
end

The config table

config = {
      tilewidth = number, -- required
      tilewidth = number, -- required
      folder = "path", -- required
      sortFolder = boolean, -- optional, default false
      mapSize = number, -- optional, default 32
      defaultTile = number, -- optional, default 1
   }

API

To be written, look at the code for now.

Installation

Just copy the luapill.lua file to wherever you want it. Then require it where you need it:

local luapill = require "luapill"

Contributing

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Added some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request

License

LuaPill is licensed under zlib/libpng License (Zlib), see the LICENSE.md.