diff --git a/xtrn/bublbogl/boggle.js b/xtrn/bublbogl/boggle.js index 7f5057edec65723141f0a1407f157631bbe600e1..8bb2cef70e910fcc07caf13aec611c10a5d12793 100644 --- a/xtrn/bublbogl/boggle.js +++ b/xtrn/bublbogl/boggle.js @@ -22,7 +22,8 @@ load("calendar.js"); load("commclient.js"); load(gameroot + "timer.js"); -var stream=new ServiceConnection("boggle"); +var interbbs=argv[0]; +var stream=interbbs?new ServiceConnection("boggle"):false; var oldpass=console.ctrl_key_passthru; function boggle() @@ -50,6 +51,7 @@ function boggle() function init() { + if(interbbs) getFiles(); calendar=new Calendar(58,4,"\1y","\0012\1g\1h"); players=new PlayerList(); player=players.findUser(user.alias); @@ -64,7 +66,6 @@ function boggle() bbs.sys_status|=SS_MOFF; bbs.sys_status |= SS_PAUSEOFF; console.clear(); - getFiles(); //TODO: DRAW AN ANSI SPLASH WELCOME SCREEN } function splashExit() @@ -74,7 +75,7 @@ function boggle() bbs.sys_status&=~SS_PAUSEOFF; console.attributes=ANSI_NORMAL; players.storePlayer(); - sendFiles(); + if(interbbs) sendFiles(); console.clear(); var splash_filename=gameroot + "exit.bin"; if(!file_exists(splash_filename)) exit(); @@ -1073,7 +1074,6 @@ function boggle() } } } - function getFiles() { console.putmsg("\1nPlease wait. Synchronizing game files with hub...\r\n"); diff --git a/xtrn/bublbogl/interbbs.doc b/xtrn/bublbogl/interbbs.doc new file mode 100644 index 0000000000000000000000000000000000000000..7e555f538c85e8aebb662701e60d0266728a56a4 --- /dev/null +++ b/xtrn/bublbogl/interbbs.doc @@ -0,0 +1,100 @@ +*****UPDATING YOUR LOCAL LIBRARIES****** + +Before you attempt to install the inter-BBS service, it is recommended that you +update your relative 'EXEC/' and 'EXEC/LOAD/' paths (typically '/SBBS/EXEC' and '/SBBS/EXEC/LOAD') +with the latest files from the Synchronet CVS repository at: + + http://cvs.synchro.net/cgi-bin/viewcvs.cgi/ + + RECOMMENDED UPDATES: + + http://cvs.synchro.net/cgi-bin/viewcvs.cgi/*checkout*/exec/load/funclib.js + http://cvs.synchro.net/cgi-bin/viewcvs.cgi/*checkout*/exec/load/calendar.js + http://cvs.synchro.net/cgi-bin/viewcvs.cgi/*checkout*/exec/load/timer.js + http://cvs.synchro.net/cgi-bin/viewcvs.cgi/*checkout*/exec/load/clock.js + http://cvs.synchro.net/cgi-bin/viewcvs.cgi/*checkout*/exec/load/msgwndw.js + http://cvs.synchro.net/cgi-bin/viewcvs.cgi/*checkout*/exec/load/scrollbar.js + + NOTE: Replace any outdated local copies with the latest release from the links. + +*****SETTING UP INTER-BBS SERVICE WITH SYNCHRONET***** + +The inter-BBS features of this program require that the appropriate services be configured, +and that all of your files are up to date. The following files are needed to operate +this program in inter-BBS mode, and can be downloaded from the Synchronet CVS repository at: + + http://cvs.synchro.net/cgi-bin/viewcvs.cgi/ + + http://cvs.synchro.net/cgi-bin/viewcvs.cgi/*checkout*/exec/commservice.js + http://cvs.synchro.net/cgi-bin/viewcvs.cgi/*checkout*/exec/load/commclient.js + http://cvs.synchro.net/cgi-bin/viewcvs.cgi/*checkout*/exec/load/chateng.js + http://cvs.synchro.net/cgi-bin/viewcvs.cgi/*checkout*/exec/load/filesync.js + http://cvs.synchro.net/cgi-bin/viewcvs.cgi/*checkout*/ctrl/filesync.ini + + NOTE: Placing these files in their corresponding local equivalent locations + will make configuration much easier. + +[COMMSERVICE.JS] + + This is a static service that must be included in /ctrl/services.ini in order to + accept connections and relay information to and from the main hub. It is critical + for this to be set up properly, for the programs that depend on it will not function + properly without it. + + This file must be placed in your relative 'EXEC/' or 'MODS/' path (typically '/SBBS/EXEC/'). + Once the file is in place, you must add the following to your 'CTRL/SERVICES.INI' file: + + [Commserv] + Port=10088 + MaxClients=20 + Options=STATIC + Command=commservice.js thebrokenbubble.com 10088 + + NOTE: there are two arguments on the command line that tell the service the address and + port of the main hub, which by default is the Broken Bubble BBS, on port 10088. If + you wish to act as your own hub (e.g. start your own league), simple remove both + arguments from the command line, and direct league nodes to add your URL and port + to their SERVICES.INI file. If your system operates on multiple machines and you wish + to share data between local nodes ONLY, setting up this service as a hub makes + this possible as well. + + NOTE: You should also double check to make sure that your services are running + +[COMMCLIENT.JS] + + This is the dedicated client that connects to the inter-BBS service. This file handles + the transmission of data to and from the service, as well as managing file synchronization + for the client (this program). This file is critical for the successful operation of this program + in inter-BBS mode. + + The file must be placed in your relative 'EXEC/LOAD/' or 'MODS/LOAD/' path (typically '/SBBS/EXEC/LOAD/'). + There is no further setup required for this to work (unless you changed the default 'Port' setting for the service + in SERVICES.INI). + +[CHATENG.JS] + + This handles all inbound/outbound chat messages, and packages them for delivery via the client and service. + this also contains the necessary objects to implement a chat room (windowed or fullscreen). + + NOTE: while this particular program may not have chat features, the service itself still may + require this file to be present. + +[FILESYNC.JS] + + This works in conjunction with the service, handling file synchronization requests from clients + and routing them, if necessary, to the main hub. File synchronization for inter-BBS programs will not + function if this file is missing. + + The file must be placed in your relative 'EXEC/LOAD/' or 'MODS/LOAD/' path (typically '/SBBS/EXEC/LOAD/'). + There is no further setup required for this to work. + +[FILESYNC.INI] + + This file tells FILESYNC.JS and COMMCLIENT.JS where to store/retrieve inbound/outbound transfers + coming from the client and the service. + + This file is critical for the service to operate properly. If you have installed the programs that + use this service to their default locations, no additional configuration should be required. + +Please report any bugs, issues or questions to: mcmlxxix at bbs dot thebrokenbubble dot com + diff --git a/xtrn/bublbogl/sysop.doc b/xtrn/bublbogl/sysop.doc index e6c0ec47c714aa11dae91ba2c99e00d1e8910d3a..aeeba3b577ce2b01b6e9a83d887868b7375ff62c 100644 --- a/xtrn/bublbogl/sysop.doc +++ b/xtrn/bublbogl/sysop.doc @@ -1,10 +1,10 @@ -Configuration in Synchronet: +Sample configuration in Synchronet (SBBSCFG.EXE): [Bubble Boggle] 1: Name Bubble Boggle 2: Internal Code BUBLBOGL 3: Start-up Directory - 4: Command Line *../xtrn/bublbogl/boggle.js + 4: Command Line *../xtrn/bublbogl/boggle.js INTERBBS <SEE INTERBBS.DOC> 5: Clean-up Command Line 6: Execution Cost None 7: Access Requirements @@ -19,3 +19,55 @@ Configuration in Synchronet: 16: BBS Drop File Type None 17: Place Drop File In Node Directory 18: Time Options... + +NOTE: The command line contains an OPTIONAL argument 'INTERBBS' + specifying whether the game is to operate in local + or inter-BBS mode. To operate local only, remove the + argument from the command line, otherwise it will attempt + to use the inter-BBS service, as described in INTERBBS.DOC. + +NOTE: It is recommended that you check frequently for updates + from the Synchronet CVS repository located at: + + http://cvs.synchro.net/cgi-bin/viewcvs.cgi/xtrn/bublbogl/ + + LINKS: + + http://cvs.synchro.net/cgi-bin/viewcvs.cgi/*checkout*/xtrn/bublbogl/board.bin + http://cvs.synchro.net/cgi-bin/viewcvs.cgi/*checkout*/xtrn/bublbogl/boggle.js + http://cvs.synchro.net/cgi-bin/viewcvs.cgi/*checkout*/xtrn/bublbogl/exit.bin + http://cvs.synchro.net/cgi-bin/viewcvs.cgi/*checkout*/xtrn/bublbogl/lobby.bin + http://cvs.synchro.net/cgi-bin/viewcvs.cgi/*checkout*/xtrn/bublbogl/sysop.doc + http://cvs.synchro.net/cgi-bin/viewcvs.cgi/*checkout*/xtrn/bublbogl/timer.js + + Replace any outdated local copies with the latest releases from these links. + (by default, these files are to be located in your 'XTRN/BUBLBOGL/' path) + +*****UPDATING YOUR LOCAL LIBRARIES****** + +Before you attempt to install the inter-BBS service, it is recommended that you +update your relative 'EXEC/' and 'EXEC/LOAD/' paths (typically '/SBBS/EXEC' and '/SBBS/EXEC/LOAD') +with the latest files from the Synchronet CVS repository at: + + http://cvs.synchro.net/cgi-bin/viewcvs.cgi/ + + RECOMMENDED UPDATES: + + http://cvs.synchro.net/cgi-bin/viewcvs.cgi/*checkout*/exec/load/funclib.js + http://cvs.synchro.net/cgi-bin/viewcvs.cgi/*checkout*/exec/load/calendar.js + http://cvs.synchro.net/cgi-bin/viewcvs.cgi/*checkout*/exec/load/timer.js + http://cvs.synchro.net/cgi-bin/viewcvs.cgi/*checkout*/exec/load/clock.js + http://cvs.synchro.net/cgi-bin/viewcvs.cgi/*checkout*/exec/load/msgwndw.js + http://cvs.synchro.net/cgi-bin/viewcvs.cgi/*checkout*/exec/load/scrollbar.js + + NOTE: Replace any outdated local copies with the latest releases from these links. + +Please report any bugs, issues or questions to: mcmlxxix at bbs dot thebrokenbubble dot com + + + + + + + +