Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rxi/lurker
Auto-swaps changed Lua files in a running LÖVE project
https://github.com/rxi/lurker
Last synced: 29 days ago
JSON representation
Auto-swaps changed Lua files in a running LÖVE project
- Host: GitHub
- URL: https://github.com/rxi/lurker
- Owner: rxi
- License: mit
- Created: 2014-03-05T20:52:38.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2023-07-22T23:29:56.000Z (over 1 year ago)
- Last Synced: 2024-11-02T08:32:33.292Z (about 1 month ago)
- Language: Lua
- Homepage:
- Size: 17.6 KB
- Stars: 282
- Watchers: 18
- Forks: 28
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-love2d - lurker - Auto-swaps changed Lua files in a running game. (Development)
README
# Lurker
A small module which automatically hotswaps changed Lua files in a running
[LÖVE](http://love2d.org) project.
## Installation
Drop the [lurker.lua](lurker.lua?raw=1) and
[lume.lua](https://raw.github.com/rxi/lume/master/lume.lua) files into an
existing project and add the following line inside the `love.update()`
function:
```lua
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:
```lua
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.
```lua
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.
```lua
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.