bbs-scene onelinerz for Synchronet Bulletin Board Systems
echicken - echicken@bbs.electronicchicken.com
onelinerz.js v1.9 & wonelinerz.ssjs v1.4 / July 6, 2010

Included:
---------
- onelinerz.js: onelinerz script for the console (read and post)
- wonelinerz.ssjs: onelinerz script for the web (read only, I'll add posting if someone wants it)
- echttp.js: an HTTP function library (GET, POST, basic authentication; grabs data from the web)
- onelinerz.ans: phlash's header graphic for the bbs-scene.org global onelinerz
- readme.txt: you're reading it, foo

Instructions:
-------------
- Go to http://bbs-scene.org and sign up for an account
- Edit the user configurable variables at the top of onelinerz.js & wonelinerz.ssjs
- Modify onelinerz.js & wonelinerz.ssjs to change the output format to your liking (optional)
- Put onelinerz.js in your sbbs/mods directory
- Put echttp.js in your sbbs/mods directory
- Put wonelinerz.ssjs in your sbbs/web/root directory (or wherever your www docroot is)
- Put onelinerz.ans in your sbbs/text/menu directory
- Call onelinerz.js with bbs.exec("?onelinerz"); wherever you want it
- Call wonelinerz.ssjs with load("wonelinerz.ssjs"); wherever you want it

Troubleshooting:
----------------
If you've followed the above instructions and are still having trouble, there's a good chance
that updating your Synchronet installation will solve your problems.  XML parsing was only
somewhat recently introduced into the javascript engine (Spidermonkey) that Synchronet uses,
and is required since bbs-scene.org exposes the onelinerz data as XML.

If you can't or won't update, there's still hope.  Set the "nonxmlmethod" variable at the top
of onelinerz.js and wonelinerz.ssjs to 1.  Now instead of querying bbs-scene.org directly, your
system will query bbs.electronicchicken.com via HTTP; my server will then query bbs-scene.org on
your behalf, parse the XML and then relay the data back to you in a format that your software
can handle.  Please note that if you use the non-XML method, my BBS is serving as a middleman
for you. You can expect the onelinerz to load a bit slower than they otherwise would.

Transparency statement: if you use the non-XML method (my system as relay) your bbs-scene.org
username and password will pass through my system in base64 encoded form.  Using your
credentials instead of my own leaves bbs-scene in control of access to their API, and base64
encoding is the same level of security that would be applied to authentication if you connected
to bbs-scene.org directly.

If you want to run this script on the telnet side of your BBS *without* a user being logged in
(at any point prior to the authentication process, or for example if you're using Synchronet as
a telnet server from which to launch another BBS application as a door), set the "guestposting"
variable to 1.  Users will be allowed to supply an alias of their choosing.  If a user is logged
in, this setting will have no effect.