library-mirrors/lovebird
1
0
Fork 0
mirror of https://github.com/rxi/lovebird.git synced 2024-11-15 22:54:21 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Updated README.md to reflected changes and additions

Browse Source
This commit is contained in:
rxi 2014-04-12 18:03:39 +01:00
parent 4492c24366
commit c47412b846
1 changed files with 14 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
README.md
View File

@ -1,5 +1,5 @@
# lovebird
A debug console for [LÖVE](http://love2d.org) which runs in the browser.
A browser-based debug console for the [LÖVE](http://love2d.org) framework.
## Usage
@ -8,18 +8,18 @@ place the following line at the top of your `love.update()` function:
```lua
require("lovebird").update()
```
The console can then be accessed by opening the following URL in your web
browser:
The console can then be accessed by opening the following URL in a web browser:
```
http://localhost:8000
```
See the section below on *lovebird.whitelist* if you want to access lovebird
from a computer other than the one which LÖVE is running on.
If you want to access lovebird from another computer on the same network then
`localhost` should be replaced with the IP address of the computer which LÖVE
is running on.
## Additional Functionality
To make use of additional functionality, the lovebird module can be assigned to
a variable when it is required:
To make use of additional functionality, the module can be assigned to a
variable when it is required:
```lua
lovebird = require "lovebird"
```
@ -32,7 +32,7 @@ The port which lovebird listens for connections on. By default this is `8000`
A table of hosts which lovebird will accept connections from. Any connection
made from a host which is not on the whitelist is logged and closed
immediately. If `lovebird.whitelist` is set to nil then all connections are
accepted. The default is `{ "127.0.0.1", "localhost" }`.
accepted. The default is `{ "127.0.0.1", "192.168.*.*" }`.
### lovebird.wrapprint
Whether lovebird should wrap the `print()` function or not. If this is true
@ -43,20 +43,19 @@ then all the calls to print will also be output to lovebird's console. This is
The maximum number of lines lovebird should store in its console's output
buffer. By default this is `200`.
### lovebird.refreshrate
The rate in seconds which the output buffer is refreshed on lovebird's page.
This is `0.5` by default.
### lovebird.updateinterval
The interval in seconds that the page's information is updated; this is `0.5`
by default.
### lovebird.allowhtml
Whether prints should allow HTML. If this is true then any HTML which is
printed will be rendered as HTML; if it false then all HTML is rendered as
text. This is `true` by default.
### lovebird.page
The HTML page template which is used when lovebird is accessed by the browser.
The default is too long to list here, see [lovebird.lua](lovebird.lua).
### lovebird.print(...)
Prints its arguments to lovebird's console. If `lovebird.wrapprint` is set to
true this function is automatically called when print() is called.
### lovebird.clear()
Clears the contents of the console, returning it to an empty state.