Beijing Paradise BBS Backup

home *** CD-ROM | disk | FTP | other *** search

/ Beijing Paradise BBS Backup / PARADISE.ISO / software / BBSDOORW / SC22.ZIP / SC.ZIP / SYNCCHAT.DOC < prev next >

Wrap

Text File | 1996-07-10 | 23.2 KB | 566 lines

╓─────┐ ╥ ┬ ╓──┐ ╓──┐ ╓─────┐ ╥ ┬ ╓──┐ ╓─╥─┐ v2.2 ║ ╙──┤ ║ │ ║ ║ ╟──┤ ╟──┤ ║ ╙─────┐ ╙──┘ ╨ ┴ ╙──┘ ║ ╨ ┴ ╨ ┴ ╨ │ ║ ╙─────┘ ╙─────┘ D O C U M E N T A T I O N ------------------------- Copyright (C) 1995, 1996 BlackLight Creations. BlackLight Creations Consists Of: Garry C. Dolley (AKA Prophet) Ryan C. Dodd (AKA Etherius) All other products copyright of their respective companies Documentation written by Garry Dolley. "The ULTIMATE in teleconferencing doors!" ┌─────────────────┐ │ F E A T U R E S │ └─────────────────┘ » You get a cool installation program. Makes installing easy. :) » You get a configuration program so you don't have to edit any text files to change your configuration, edit strings, add IGMs, etc... » An advanced Action system. Users can see what an action will look like before they use it (Ex: "HF HELP" or "HUG HELP"). Actions are easily edited by the SyncChat Configuration Editor and compatible with the Renegade ACTIONS.LST format. » Every string displayed by SyncChat can be edited with the easy to use SyncChat Configuration Editor, no need to hassle with text files. This allows you to configure SyncChat to the look and feel you wish to obtain. » Games! Games! Games! :) Games can be installed into SyncChat so users can have very easy access to games they'd like to play. They won't have to exit SyncChat and go to the online games menu to run a game. Other users in SyncChat will be notified of which users are playing the games, so those users can join in if they'd like! » SyncChat supports multiple channels. Each user gets their own private channel to talk privately to whomever they wish. Each user can also join multiple sysop definable public channel to talk publicly to everyone else. » Each channel can have it's own topic. For private channels, only the owner of the private channel can change the topic, and for the public channels, anyone can change the topic. » Each channel can have it's own different set of actions. » SyncChat supports the popular ">" and "/" direction/whisper commands. If you have used the MBBS (Worldgroup) teleconference, you probably are already familier with these. These commands come in very handy when chatting with more than two people. » Whispers (private messages sent with the "/" command) can be seen by anyone with a SL of 90 or higher. » When using commands such as "/", ">", or issuing an action, users only need to type the first THREE letters of the persons handle to which they are directing the command. For example, to use the HIGHFIVE action and direct it to Prophet, they just need to type "HIGHFIVE PRO" not "HIGHFIVE PROPHET". This comes in very handy and is a great help to the people who don't like to type in long user names (or even short ones ;). » The default help and actions help displays can be customized by two .ASC and/or .ANS files (see below). » SyncChat works hand in hand with SyncRegistry so you can offer a complete user registry to your users, and your users can look-up profiles while they are chatting! » A RAM drive is supported and recommended as a temporary/swapping directory to increase the speed of SyncChat and the rest of the BBS. » SyncChat has a strong MBBS feel to it. It was designed this way so sysops could run this type of teleconference without having to spend a billion dollars running and maintaning a MajorBBS board (oh now watch me get sued...) ┌───────────────────────────────────────┐ │ I N S T A L L A T I O N S A M P L E │ └───────────────────────────────────────┘ For Synchronet SysOps: In case you need to see how to configure SyncChat in SCFG again, here's the sample: ╔[■][?]════════════════════════════════════════════════════╗ ║ SyncChat ║ ╠══════════════════════════════════════════════════════════╣ ║ │Name SyncChat ║ ║ │Internal Code SYNCCHAT ║ ║ │Start-up Directory ..\XTRN\SYNCCHAT ║ ║ │Command Line SYNCCHAT.EXE ║ ║ │Clean-up Command Line ║ ║ │Execution Cost None ║ ║ │Access Requirements ║ ║ │Execution Requirements ║ ║ │Multiple Concurrent Users Yes ║ ║ │Intercept I/O Interrupts No ║ ║ │Swap BBS out of Memory Yes ║ ║ │Modify User Data No ║ ║ │Execute on Event No ║ ║ │BBS Drop File Type Synchronet XTRN.DAT ║ ║ │Place Drop File In Node Directory ║ ║ │Time Options... ║ ╚══════════════════════════════════════════════════════════╝ For Other BBS Software ---------------------- The command line for SyncChat is very simple: SYNCCHAT [node_dir] Example: SYNCCHAT C:\BBS\NODE1 The [node_dir] must be the directory where DOOR.SYS is generated. Set up your software to generate a DOOR.SYS in this direcotry. I recommend you use this batch file as well (obviously, change paths as needed): --[SYNCCHAT.BAT]-- C: CD\DOORS\SYNCCHAT SYNCCHAT C:\BBS\NODE%1 --[SYNCCHAT.BAT]-- If you use this batch file, with Renegade, for example, your command line would be: C:\RENEGADE\SYNCCHAT.BAT %N And with Telegard 2.99 it would be: C:\TELEGARD\SYNCCHAT.BAT ~CN ATTENTION INIQUITY A25R2 SYSOPS ******************************* Since Iniquity a25r2 isn't a full multinode BBS software yet, the above batch file will probably not work. I have been told that this one will: --[SYNCCHAT.BAT]-- C: CD\DOORS\SYNCCHAT SYNCCHAT C:\INIQUITY\DOORS --[SYNCCHAT.BAT]-- Iniquity will generate a DOOR.SYS file in \INIQUITY\DOORS. (Provided you set up SyncChat with the "D3" menu command). Requirements ------------ Basically, the only thing SyncChat requires is a FOSSIL driver. It has been tested with BNU and X00 without any problems. ┌───────────────────────────┐ │ C O N F I G U R A T I O N │ └───────────────────────────┘ Configuration of SyncChat is extremely easy. Just type SCONFIG when you're in your SyncChat directory. An explanation of each command follows: BBS Name, SysOp Name, Registration Code, and Temporary Directory ---------------------------------------------------------------- Duh ;) Fill these options out accordingly. If you have not registered, you may put a 0 as your registration code. Note: When specifying the temporary directory, the directory name MUST NOT CONTAIN NUMBERS. Also Note: The temporary directory is optional. If you don't edit it, it will default to the main SyncChat directory. Remember, it is recommended that you use a RAM drive as a temporary directory. It will increase the speed of SyncChat and the rest of your BBS. BBS Software, Number Of Nodes, SysOp Level, Multitasker ------------------------------------------------------- Be sure you fill out these options CORRECTLY before you ever run SyncChat. If the BBS Software you run is not listed, select "Other". If you run Synchronet BBS software, you don't have to worry about the "Number of Nodes" option, it is automatically read out of the XTRN.DAT drop file. Note: If your BBS software is not listed, then you will not be able to use the (P)age and (W)ho's Online options in SyncChat. This is because each BBS software uses a different method to handle these functions, and SyncChat must be programmed to handle each different method. SyncChat is being constantly upgraded to support different software, so keep a lookout on future releases, they may very well support your BBS software!! The "SysOp Level" option is used to tell SyncChat what is the minimum security level that a user may have to be considered a 'SysOp'. These users will be able to see private whispers (private messages), edit actions, etc... For example, if you are using Synchronet, you should set this option to 90. If you are running Telegard, you may want to set this option to 250. The "Multitasker" option should not be very hard to figure out ;) Set this to Multitasker you use. If you are running Synchronet, there is no need to set this option, XTRN.DAT passes your multitasker info to SyncChat automatically. "Root" BBS Directory -------------------- If you select "Impulse" or "Telegard 3.0+" as your BBS Software, you will also have to tell SCONFIG where your "root" BBS directory is. You will see this option as letter "D". Example of directories to put: C:\TG, D:\IMP, C:\TELEGARD, D:\IMPULSE, etc... It is very important that this field is accurate and not left blank! The IGM Editor -------------- IGM stands for In Game Module. Even though SyncChat is not a game, we chose the name IGM because of Seth Able's LORD. I mean, why invent a new ancronym (ITM - In Teleconference Module??), when games for SyncChat install and behave much like IGMs in LORD? Why add an IGM? Simple answer, every played MajorBBS's BRAWL? Don't know about you, but 10 people shootin' it out in a nice game of BRAWL is VERY fun. (Now we just gotta find someone to write a BRAWL door ;) IGM names may contain CTRL-A codes for you colorful people. :) The IGM data file, GAMES.DAT, has the same format as LORD's 3RDPARTY.DAT. For those of you not familier with that format, here it is: [PATH AND FILENAME OF EXECUTABLE] [IGM NAME] The PATH AND FILENAME line may contain a '*' which will translate into the node number of the node SyncChat is currently running on. Here's an example: ---------- [Begin GAMES.DAT] ----------- C:\SBBS\XTRN\SBJ\SBJ.BAT * Synchronet BlackJack! C:\SBBS\XTRN\SMM\SMM.EXE Synchronet Match Maker ---------- [ End GAMES.DAT ]------------ This is just reference information, you don't have to edit the GAMES.DAT directly, just use the IGM Editor. WARNING: DO NOT SPECIFY A PATH OR FILENAME THAT DOES NOT EXIST, UNEXPECTED OPERATION WILL RESULT! IMPORTANT: Unlike previous version of SyncChat, you CANNOT run normal Synchronet specific games (i.e. Domain Poker, Synchronet Lottery, etc...). This is because SyncChat is no longer designed with the same communications routines as those games. You MAY run normal 'Modem Aware' games. The String Editor ----------------- This is easy and self-explanatory. :) Simply choose the string you'd like to edit and proceed to enter in the new string. You may use CTRL-A codes for color and each string may be up to 160 characters in length. Special Note: Be sure to keep the same amount of "%" codes in the original string as in the new string. Just like Synchronet's TEXT.DAT. For those of you not familier with Synchronet, here's an example: If you have a string like this...: You are in the %s channel. And you change it, SOMEWHERE, you must put the "%s". Here are a few CORRECT changes you can make: YoU ArE iN thE %s CHaNNeL. You are now talking in the %s channel. You are currently in the %s public channel. Here is a VERY INCORRECT change: You are in the Main channel. (Notice the string above does not contain a "%s"!!) Keep this in mind, and you won't have any problems! If you ever find that you want to set all the strings back to the default, delete the file STRINGS.DAT, and then run SCONFIG->String Editor. A new STRINGS.DAT will be created with the default strings. The Actions Editor ------------------ When you first enter the Actions Editor, you are asked for what Actions File you want to edit. This lets you have multiple action files. Why would you want to have more than one action file? Well, each channel can have it's own set of actions (See "The Channel Editor" section). If you only want or need one action file, just press ENTER, and the default actions file (ACTIONS.LST) will be used. The format for any actions file is as follows: [ACTION WORD] <-- 12 chars max [STRING SHOWN TO USER - "RESPONSE"] <-- 128 chars max [STRING SHOWN TO ALL BUT RECIEVER] <-- 128 chars max [STRING SHOWN IF THERE IS NO RECIEVER] <-- 128 chars max [STRING SHOWN TO RECIEVER] <-- 128 chars max This file can be edited manually, but it's much easier to use this editor. Two codes can be used for the "Sender" and "Reciever". They are both "%s". The first "%s" in the string is always the sender, and the second "%s" is the reciever. Another code, "~s~", will be replaced by "him" or "her" depending on the sex of the sender of the action. The code "~r~" works much like "~s", but it will be replaced by "his" (not "him" like ~s~) or "her". None of these codes need to be used in the string. Another important code is "~*~". This code is replaced with whatever text the user types after they type in the action. For example, the user may type "THINK How am I going to do this?", and everyone else may see: "Prophet <thinking>: How am I going to do this?". Refer to the example ACTIONS.LST below to see how this "THINK" action is set up. The third line of the action (Text sent to all users) will always contain the "~*~" code if it is to be used. Also, if any action contains this code, the LAST line of the action (Text sent to reciever of action) is NOT used (because actions like these cannot be directed to other users). It can contain any text but putting "NULL" is commonly used. Also note, the "~*~" will only work in the THIRD line of an action. A sample ACTIONS.LST follows: ---------- [Begin ACTIONS.LST] ----------- HF ...BAM! %s just gave %s a high five!! %s gave EVERYONE a high five!! %s gave YOU a high five!! LAUGH ...HAHAHAHAHAH..... %s is laughing at %s! %s is laughing ~r~ fool head off!! <-- Note the "~r~" code. %s is laughing at you! It will translate into SUICIDE "his" or "her". ...You're history, bub... %s killed ~s~self! <-- Note the "~s~" codes. %s killed ~s~self! They will translate into %s killed ~s~self! "him" or "her". THINK ...Interesting %s <thinking>: ~*~ <-- Example of "~*~" Code. %s is comtemplating life... NULL GA (Generic Action Sent) %s ~*~ <-- Another example. %s NULL ---------- [ End ACTIONS.LST ] ----------- The Channel Editor ------------------ This one is pretty self-explanatory ;) Each channel name can be up to 80 characters in length and you can use CTRL-A codes for color. The "Min. SL" column lists the minimum security level value needed to enter the corresponding channel. The "Actions File" section lists what actions file is used for the corresponding channel. This lets each channel have it's own set of actions. If you just want each channel to use the same set of actions, you can set this field to "ACTIONS.LST". Toggles ------- Here's a long description of each of the toggle-able options: * Delete Topic If Everyone Leaves A Channel If this option is set to "Yes", if every user leaves a certain channel, the current topic will be deleted. If this is set to "No", then the topic for public channels is not deleted until someone overwrites the current one. * Delete Prompt Before Displaying Messages If this option is set to "Yes", the current prompt (Usually a ":") will be deleted before a message is displayed. This is a 'cleaner' mode to work with. More messages will also fit on a screen at a time. Just try it and see if you like it :) Kick Users Who Are "Stuck" In SyncChat -------------------------------------- If you ever see that SyncChat reports that someone is in chat but they are really not, choose this option and the user(s) will be "kicked off". NOTE! SYNCCHAT MUST NOT BE RUNNING FOR THIS OPTION TO WORK PROPERLY. Optional Files -------------- Instead of SyncChat displaying the default 'menus', you can use optional files to display your own custom versions of these menus. Here's a list of these optional files: HELP.* Main Help Options. What user sees when they press "?" in SyncChat. ACTHELP.* Actions List and Help. What user sees when they press "A" in SyncChat. The "*" can be .ASC or .ANS (i.e. HELP.ANS or HELP.ASC). The .ASC version can contain CTRL-A codes or no codes at all. The .ANS version can contain ANSI codes. The .ANS version will be displayed to ANSI callers, and the .ASC version to non-ANSI callers. If you don't have an .ANS version, the corresponding .ASC version will be displayed. These files should be located in the main SyncChat directory. ┌───────────────────────┐ │ C O L O R C O D E S │ └───────────────────────┘ SyncChat uses Synchronet CTRL-A codes to change color in strings, actions, and in actual chat. Type COLOR.ANS to see the actual chart of the codes. Starting with version 2.2, SyncChat also supports Telegard PIPE (|) color codes. These may be used anywhere CTRL-A codes are used. ┌─────────────────────────┐ │ S Y N C R E G I S T R Y │ └─────────────────────────┘ Note: SyncRegistry 1.0 can no longer be run from SyncChat. Grab a copy of SyncRegistry 1.7. SyncRegistry is included with the SyncChat archive. SyncRegistry is an external program (SYNCREG.EXE) that SyncChat calls whenever your users want to enter the Registry. Since it is an external program, you may wish to let your users have access to it OUTSIDE of SyncChat (i.e. At Logon). For Synchronet sysops: Here are the proper settings in SCFG for SyncRegistry: ╔[■][?]════════════════════════════════════════════════════╗ ║ SyncRegistry ║ ╠══════════════════════════════════════════════════════════╣ ║ │Name SyncRegistry ║ ║ │Internal Code SYNCREG ║ ║ │Start-up Directory C:\SBBS\XTRN\SYNCCHAT ║ ║ │Command Line SYNCREG.EXE ║ ║ │Clean-up Command Line ║ ║ │Execution Cost None ║ ║ │Access Requirements ║ ║ │Execution Requirements ║ ║ │Multiple Concurrent Users Yes ║ ║ │Intercept I/O Interrupts No ║ ║ │Swap BBS out of Memory Yes ║ ║ │Modify User Data No ║ ║ │Execute on Event No ║ ║ │BBS Drop File Type Synchronet XTRN.DAT ║ ║ │Place Drop File In Node Directory ║ ║ │Time Options... ║ ╚══════════════════════════════════════════════════════════╝ For other BBS Software: The command line for SyncRegistry is exactly like SyncChat: SYNCREG [node_dir] Ex: SYNCREG C:\BBS\NODE1 ┌─────────────────────────────────────┐ │ N E W U S E R Q U E S T I O N S │ └─────────────────────────────────────┘ If you do not run Synchronet BBS Software, anyone who has entered SyncChat for the first time will be asked if they are male or female. This is because the DOOR.SYS drop file does not provide gender information. XTRN.DAT (Synchronet's native drop file), however, does. THIS QUESTION IS ONLY ASKED ONCE. It's innevitable that a user will put false information either accidently or they are trying to be stupid. To make the New User Question pop up again for that user, delete this file: C:\DOORS\SYNCCHAT\SEX\<user_number>.M <-- Could be "F" for female. Ex: DEL C:\DOORS\SYNCCHAT\SEX\118.M If you delete that file, the user with user number "118" will be asked if they are male or female upon entering SyncChat. Note, it will NOT be asked again after that point, unless you delete the 118.M file again. ┌─────────────────────────┐ │ R E G I S T R A T I O N │ └─────────────────────────┘ The Unregistered version of SyncChat will allow a user to stay in chat for only 10 minutes, then he/she will be kicked out. They may, however, go back into SyncChat. There is also a limit of two IGMs that can be configured. Registration will get rid of these limitations. It also helps Ryan Dodd and I (Garry Dolley) make upgrades and deliver a better product. Registration is a one time process, so upgrades are FREE! It only costs $25. Refer to the ORDER.TXT file included with this archive to register your copy of SyncChat. Thanks for your support! ┌─────────────────────────┐ │ T H A N K S T O . . . │ └─────────────────────────┘ Thanks to our beta sites: The O-Zone BBS (810-651-6472) [SysOp: Tom Fotherby] The Game Room BBS (1:2201/11) [SysOp: Bill Cronkhite] Thanks to Korrupt for letting me steal some of his actions ;) (Exodus Crossroads - 213-756-4167 or 213-756-7381) Thanks to Meshuga of IRC for letting me steal HIS actions too ;) Thanks to enigma of The O-Zone for writing the CHAT.SRC module! Thanks to Rob for making XSDK, so us programmers could play with it :) and... Thanks to all of Digital Dynamics for making Synchronet, the best BBS software ever! ┌─────────────────────────────────────────────────────────────────────┐ │ T E C H N I C A L S U P P O R T A N D D I S T R I B U T I O N │ └─────────────────────────────────────────────────────────────────────┘ SyncChat Home BBSs: Dragonspear Castle BBS (SysOp: Prophet) 818-240-9102 or 818-240-0318 Daggerfall Ruins BBS (SysOp: Etherius) 213-726-3010 You can email me (Garry) at any time with any questions/comments/troubles you may have. Some places I can be reached at are: gcd@silicon.net (Internet) 85:805/117 (ITCnet) 1:102/854 (FIDOnet) The latest version of SyncChat can be found at the above two BBSs. It can be downloaded directly from the Matrix Logon so you can minimize your time online and not kill your phone bill. ;) In addition, you can FREQ the latest version with the magic name "SYNCCHAT" from the following addresses: 85:805/117 (ITCnet) SysOp: Garry Dolley (me!) 85:85/0 (ITCnet) SysOp: Jack Reece 1:102/854 (FIDOnet) SysOp: Garry Dolley 1:102/835 (FIDOnet) SysOp: Jack Reece 1:2201/11 (FIDOnet) SysOp: Bill Cronkhite I'd really like to hear from some of you who use this program. Let me know what you think about it! Also, if you find a bug, report it promptly, and I will fix it! Thanks! -Garry Dolley