bbs-scene.org onelinerz for Synchronet Bulletin Board Systems
echicken@bbs.electronicchicken.com
January 24th, 2011

echttp.js v1.2
ecFunctions v1.0
onelinerz.js v3.2
randomoneliner.js v1.2
wonelinerz.ssjs v1.8

What's New
----------

Improved handling of colour codes in the text input function.

Introduced a pop-up colour palette for users who don't want to memorize pipe codes.

Broke out some functions not specific to the global onelinerz into ecFunctions.js
so that they can be reused (by myself and others) easily in the future.


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

bbs-scene.ini		- Contains info about your bbs-scene.org account
echttp.js		- My library of HTTP functions (geared toward fetching XML)
ecFunctions.js		- A small library of functions (mostly colour-code related)
onelinerz.ans		- The onelinerz header graphic by phlash
onelinerz.js		- The main onelinerz script, for the console
randomoneliner.js	- A script that prints out a single oneliner on the console
wonelinerz.ssjs		- A semi-useful onelinerz script for the web

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

-	Place echttp.js, ecFunctions.js, onelinerz.js and randomoneliner.js in your
	mods directory, place wonelinerz.ssjs somewhere within your Synchronet web-
	server's document root, and place onelinerz.ans in your text/menu directory
	overwriting any existing copies.

	It's up to you to determine where and how to call these scripts.

-	If you already have a bbs-scene.ini file in your ctrl directory, do not
	overwrite it; simply paste the [onelinerz] section from the included file
	into your existing file, overwriting your existing [onelinerz] section if
	you have one.
	
	If you do not already have a bbs-scene.ini file in your ctrl directory, put
	the included bbs-scene.ini file there.
	
-	Edit ctrl/bbs-scene.ini to your liking.  See the "Configuration" section of
	this file for explanations of the key/value pairs.

-	Recent changes to echttp.js may require you to update other bbs-scene related
	scripts after you perform this upgrade.

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

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

[Account]			This section contains settings related to your bbs-scene
				user account and how it is accessed.

username			Your bbs-scene.org username (ie. your email address)

password			Your bbs-scene.org password

server				The server address (You probably want to leave this as is)

port				The port to access on 'server' (Again, best left as is)

timeout				How many seconds to wait for a response from the server
				(The scripts *should* exit quietly if no response is to be
				heard, so set this to as long as you'd be willing to sit at
				a blank screen with no indication of what's going on.)

apiPath				The path to access on 'server' (ie. the /api/ portion of
				bbs-scene.org/api/)

[onelinerz]			This section contains settings related to the global one-
				linerz scripts.

BBSName				The name of your BBS, in its shortest possible form. (My
				BBS is the 'electronic chicken bbs', but I have set my
				'BBSName' to 'ecbbs' to conserve screen real estate.)

displayFile			The name (minus extension) of a file in your text/menu
				directory to display at the top of the screen.
					
limit				How many oneliners to display.  The default setting of 14
				fits nicely beneath the header graphic and above the input
				line on a 24 line terminal.
					
webLimit			How many oneliners to display if using the web script

aliasLength			The maximum length of an alias.  Long usernames will be
				truncated to this size.  8 - 12 seems reasonable to me; too
				much more and the user's message will be cut very short.

BBSNameLength			As above, but for BBS names

ansiColourOneliner		The colour of oneliner text, as an ANSI sequence

ansiColourAlias			The colour of a user's alias, as an ANSI sequence

ansiColourBBSName		The colour of BBS names, as an ANSI sequence

ansiColourRandomOneliner	The colour of oneliner text when using the random
				oneliner script, as an ANSI sequence

ansiColourRandomAlias		The colour of user aliases when using the random
				oneliner script, as an ANSI sequence

ansiColourRandomBBSName		The colour of BBS names when using the random
				oneliner script, as an ANSI sequence

bannedUsers			A comma-delimited list of users (aliases or real names) who
				are disallowed from posting oneliners

colourCodes			1 to interpret colour codes, 0 to strip them.