Auto-swaps changed Lua files in a running LÖVE project
Lua
Latest commit 2da9d44 Mar 4, 2015 @rxi Updated copyright year
Permalink
Failed to load latest commit information.
.gitignore
LICENSE
README.md
lurker.lua

README.md

Lurker

A small module which automatically hotswaps changed Lua files in a running LÖVE project.

Installation

Drop the lurker.lua and lume.lua files into an existing project and add the following line inside the love.update() function:

require("lurker").update()

Lurker will automatically detect changed files and hotswap them into the running project.

Additional Functionality

To more easily make use of additional functionality, the lurker module can be set to a variable when it is required into the project:

lurker = require "lurker"

lurker.scan()

As opposed to using the lurker.update() function -- such to avoid the overhead of repeatedly polling for file changes -- you can instead opt to trigger a scan of the directory by calling lurker.scan() manually. If the scan detects any changes a hotswap is performed.

lurker.preswap

lurker.preswap can be set to a function. This function is called before a hotswap occurs and is passed the name of the file which will be swapped. If the function returns true then the hotswap is canceled.

lurker.preswap = function(f) print("File " .. f .. " swapping...") end

lurker.postswap

lurker.postswap can be set to a function. This function is called after a hotswap occurs and is passed the name of the file which was swapped.

lurker.postswap = function(f) print("File " .. f .. " was swapped") end

lurker.protected

Dictates whether lurker should run in protected mode; this is true by default. If protected mode is disabled then LÖVE's usual error screen is used when an error occurs in a LÖVE callback function; if it is enabled then lurker's error state (which continues watching for file changes and can resume execution) is used. Changes to this variable should be made before any calls to lurker.update() are made.

lurker.quiet

Dictates what should happen if lurker tries to load a file which contains a syntax error. If it is false then lurker's error screen is shown until the syntax error is fixed; if it is true the error message is printed to the console and the program continues. lurker.quiet is false by default.

lurker.interval

The interval in seconds for how often the scan of the directory is performed. This is .5 by default.

lurker.path

The directory which is scanned for changes. This is . (The project's root) by default.