bbs-scene.org Random BBS Advertisements for Synchronet BBS
echicken@bbs.electronicchicken.com

randombbs.js v1.0
wrandombbs.ssjs v1.1
echttp v1.1

What's Included
---------------

bbs-scene.ini	- Contains configuration settings
echttp.js	- My library of HTTP functions
randombbs.js	- Fetches and displays a random BBS ANSI advertisement from bbs-scene.org
wrandombbs.ssjs - Fetches and displays a random BBS PNG advertisement from bbs-scene.org (for the web)

Installation
------------

- Back up your shit before you follow any of the installation & configuration steps
  described in this file and before you run any of these scripts.

- Copy echttp.js and randombbs.js to your sbbs/mods/ directory.  If you already have
  a copy of echttp.js, don't overwrite it unless it is older than the copy included
  in this package.
  Call randombbs.js from another script with 'bbs.exec("?randombbs");'

- Copy wrandombbs.ssjs to somewhere in your sbbs/web/root/ directory, or wherever
  your web document root is.
  Call wrandombbs.ssjs from within another ssjs with 'load("?wrandombbs");'

- Copy bbs-scene.ini to your sbbs/ctrl/ directory.  If you already have a copy of
  bbs-scene.ini, don't overwrite it.  Instead, simply copy the RandomBBSAd section
  from the bbs-scene.ini included in this package and pasted it into the bottom of
  your existing bbs-scene.ini.

Configuration
-------------

Your configuration is stored in sbbs/ctrl/bbs-scene.ini, and the keys therein are as follows:

[Account]		- This section contains settings related to your user account and
			  your connection to bbs-scene.org.

username		- Your bbs-scene.org username.  Typically the email address that you
			  supplied when signing up.

password		- Your bbs-scene.org password.

server			- The IP or FQDN of the server hosting the BBS Scene API.  You probably
			  don't need to edit this, but if somebody decides to host a fully
			  compatible service somewhere else, or if Netsurge has to move the site
			  to another domain someday, all you'll need to do is edit this setting
			  to reflect the change.

port			- The default is port 80.  It's even less likely that you'll ever need
			  to change this setting.

timeout			- How many seconds to wait for a response from the server. 2 is usually
			  plenty, but increasing this can sometimes be a useful troubleshooting
			  step.

apiPath			- The path to the API resources on the server. You'll likely never need
			  to change this unless Netsurge moves the API.

[RandomBBSAd]

preLoadMessage		- The text to display prior to printing the ANSI advertisement to the
			  screen in the console version of the script.

preLoadMessageColour	- The colour of the text of the preLoadMessage

preLoadMessageDelay	- How many milliseconds to wait between whoing preLoadMessage and the
			  printing of the ANSI advertisement.

exitDelay		- How many milliseconds to wait after displaying the ANSI advertisement
			  before exiting the script.

pngThumbnailSize	- How big, as a percentage of the image's full size, should PNG thumbnails
			  be. (Do not include a % symbol.)

pngThumbnailTextDetails	- true or false, whether or not to print out some brief textual details
			  underneath PNG thumbnails of BBS advertisements.

pngThumbnailLinkFullsize- true or false, whether or not the PNG thumbnail should be a link to a
			  fullsized version of the advertisement. (Note: the fullsize view is a
			  bit bland at the moment; recommend that you customize it by editing
			  wrandombbs.ssjs.)

pngFullsizeTextDetails	- true or false, whether or not to print out some textual details beneath
			  the fullsize PNG (if pngThumbnailLinkFullsize is set to true above.)