AQMARQEE V 1.0 Beta READ: Don't think you can get by without at least looking over this doc. Failure to read will cause you grief. Sysops have wasted hours of time trying to write a ppe so that they can prevent AQMARQEE from running on slow modems. If they looked at this doc, they would have found that I covered this for them in the initial release. Please read. GENERAL: Aqmarqee was written with the Pcboard Programming Language, you will need to be running Pcboard 15.1 in order to use this program. This program was written out of the need to get our callers to read some of the more important aspects of the system. Its also a great subscription prompter . Our document writing is not the best, we've tried to get it as complete and accurate as possible. We have made quite a few last minute changes before the release so there might be a few inaccuracies. If you need assistance feel free to call our system and ask questions, leave comments or bug reports. DESCRIPTION: Have you ever seen one of those one line signs in the store, well this is what AQMARQEE does. The text that you wish to be displayed will be shown on Line 1 of the Pcboard menu. with a header on each side. It is configurable to be used in other locations of your system such as the bulletin display, etc... Lets get all the legal stuff out of the way first. LICENSE TO USE AGREEMENT: Aquila BBS grants a nonexclusive license to use AQMARQEE. Aquila BBS shall have the right to terminate this license if purchaser violates any of its provisions. Purchaser agrees that the software and accompanying materials are the property of Aquila BBS and that Aquila BBS shall maintain title to and ownership of the software at all times. Aquila BBS makes no warranties of any kind, expressed or implied, with respect to the quality, performance, accuracy, or fitness of AQMARQEE. Aquila BBS assumes no responsibility for any decisions made or actions taken on the part of the purchaser because of the use of AQMARQEE. In no event shall Aquila BBS, or any of its representatives, be liable for any loss of profit or damage arising from the use or inability to use AQMARQEE even if Aquila BBS or an authorized agent of Aquila BBS has been advised of the possibility of damage. DISCLAIMER: IN NO EVENT WILL AQUILA BBS BE LIABLE TO YOU FOR ANY DAMAGES, INCLUDING ANY LOST PROFITS, LOST SAVINGS OR OTHER INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF YOUR USE OR INABILITY TO USE THE PROGRAM, OR FOR ANY CLAIM BY ANY OTHER PARTY. AQMARQEE(c) is copyrighted by AQUILA BBS PCBoard is a Registered Trademark of Clark Development Company PKZIP is a Registered Trademark of PKWARE PROVISIONS: 1: You may use the program for 2 weeks for evaluation purposes, at the end of the 2 weeks you are required to either register the program, or discontinue its use on your BBS. 2: You may not give out your registration number to others, your license to use the program will be immediately revoked if another copy is found to be in use on another system. 3: You may distribute AQMARQEE to others so long as all the files that are on the evaluation copy, have not been modified or tampered with in any way. And no files have been added to the distribution file. BBS PROVISIONS: BBS's may distribute AQMARQEE provide you follow Provision 3 above. WHATS THAT LEGAL STUFF MEAN: We're not responsible for anything that happens or could happen from your use or anyone else's use of this program. CONFIGURATION: Unzip the program in a new directory, we recommend PCB\PPL\MARQEE Lets start off with the configuration file, you'll need to set this up first before you can go any farther. Use MARQEE.CFG this is the one I will be looking for. Feel free to remove any or all of the text after the comments to pretty up your cfg file. The only reason the comments are their is to help you configure it on the first try. Line 1: This is your BBS NAME, you must type it in EXACTLY how you want it displayed to the caller. Your registration key is also tied to the text you type in this line. A semicolon is used to end all inputs so do NOT take them out. Maximum 40 characters. Example: Aquila BBS; Don't forget the Semicolon you can place any comments afterwards if you would like. Line 2: This is your registration number that we will supply you once you have registered the program. Enter a 0 here if you are evaluating the program. Example: 0; Don't forget the semicolon Line 3: This is the line for your custom left header, you are allowed 20 characters maximum. You may insert Pcboard Color Codes, to spruce up the header. The @ codes do not count towards the 20 character limit. Example: ÛÛÛÛÛÛÛÛÛÛÛÛÛÛÛÛÛÛÛÛ Example: ÛÛÛ@X0CÛÛÛÛÛÛ@X0AÛÛÛÛÛÛÛÛÛÛÛ Line 4: This is the right header, all the same rules apply as in line 3. Line 5: This is the color code that you will set for your left header If you used color codes in the custom header then those will override the color you place on this line. This is primarily used for the color of the predefined headers below. Example: @X0C; Line 6: This is the color code for the right header, all the same rules will apply for Line 5 Line 7: Text Color, This is the color of the text that will be displayed in the Marqee Window. This is also the initial color that is cleared at startup. Example: @X0F; Line 8: We have 3 default Headers that you may use here, 1: Standard ===========> 2: Fader °°°°°±±±±±²²²²²ÛÛÛÛÛ 3: Raceway ßÜßÜßÜßÜßÜßÜßÜßÜßÜßÜ Example: 2; Line 8 also has a "C" switch which is used in conjunction with Line 15 below. It prevents left and right overwrites at the initialization. Line 9: Enter your internet address, this will be appended to the callers name, this only works when using the @INTERNET@ macro. If you use the @INTERNET@ macro, make sure you have filled in this line, otherwise it will display an error message to the caller. Example: @aquila.com The caller will see first.last@aquila.com Line 10: This is the speed at which you want to display the text to the caller. 3 is recommended, 18 is approximately one second. Note: This will also affect your keyboard type rate, its best to keep the number fairly low. A 0 is to fast and callers will have a difficult time reading the text. Line 11: This is the number of times you would like the marqee to be displayed. Example: 3 It will rotate three times and stop. Use a 0 if you want it to be continuous. Line 12: This is the row display that you want your text to be displayed. 1 is the Default line. Line 13: This is the size of the text that you want displayed. The Default is set at a 39 character display. The text will be displayed based on a 78 character centered display. The larger you make your character display the slower it will appear to the caller. We have found that 39 is a fair number for display. NOTE: The text display cannot be set less than the length of your bbsname length. If it is then your bbsname length will be used instead. Note: If you deviate from the 39 character default display all header selections including custom headers will be NULLIFIED. It will be up to you to make your own left and right headers in your menu screen. This way if you have an empty space in the center of your menu screen like we do you can display AQMarqee text without destroying any text left or right of the scrolling text. Set this up and test it first to see the printing positions before changing your menu's around. Line 14: This switch will toggle the display of your bbs name at the end of the text scrolling. Select Y if you want the BBSNAME displayed, or N if you do not want your bbs name displayed. A blank field will be the result after the display is finished, or the start over of your text depending on how you have the number of times to display switch set. Line 15: Column start position for deviating from the default centering routine. Make sure Line 13 of your text added to this line does not exceed your screen length. Line 8 must also use the "C" Switch. * Registered Version Only. Do not enter anything in this line other than the ; placeholder if you will not be using this switch. Line 16: Expired Security Level for Expired Text, this is the security level that you can set for a caller who is in an expired status. Anyone who is this security level will be displayed Line 17: Expired Text. Line 17: Expired Text field: This line will be displayed to the caller who has a security level based on line 16. Line 18: There are 5 options available "A", "N", "Y", "F", "FR". "A" Will display all seven text lines one right after the other. "N" Will Display Only Text #1 "Y" Will Display Text #1 on Sunday, #2 on Monday, etc,. "F" Will display a text file to the caller, which you will point to later lower in the .CFG file. The file must not be larger than 2048 bytes, if it is only the first 2048 will be displayed the rest will be discarded. * The F Switch is available only in the Registered version. "FR" This is a random display switch, Using Line 32 you will point to a file that you would like displayed randomly. Each line in the file should be a complete sentence since it might look odd to a caller when it is displaying the lines in a random order. You do NOT have to end each sentence with a ;. * This option is available only in the Registered Version. Example: Y; Example: A; Example: FR; Line 19: This is the Security Level that you can set for the Security Text Line. We use a one line text for callers who have expired and we are prompting them to resubscribe, although you can use it for other things. NOTE: Anything = to or below this security level will see the Security Text Line. They will never see any of the other text lines. Example: 21; Line 20: This is the Security Text Line that will show to callers whose security level is less than or equal to Line 19 NOTES: There is a 255 character limit, be careful if you are using the allowed @ parameters. NOTES: Do not attempt to insert @ Color Codes you will trash the display routine. NOTES: There are 7 Insertion parameters allowed @FIRST@ this will be in mixed case, @FIRSTU@ all uppercase, @USER@ mixed case, @USERU@ all uppercase, @INTERNET@, @TIME@ the current time (this is when the marqee begins its display, since we don't want to slow the program, we won't be checking for time over and over) @DATE@ Today's Date. No other insertion parameters are permitted, so don't try. Results will be undesirable. If you have not inserted your internet address on config line 9 the caller will be displayed "error" when you use the @INTERNET@ parameter. Example: Hi @FIRST@, your subscription has expired, Type ACCESS to resign up ; NOTE: You do NOT make a TEXT1, TEXT2, TEXT3,...etc File it is all done on the config file. The only exception is for Lines 31 and 32 below, when using the F, FR switches on line 18. Line 21: This is your first TEXT LINE:1 all the Notes listed in Line 20 apply. See Line 18 for Information on when this line is displayed. Example: To Download the master filelist, type D allfiles.zip at the main command prompt; Line 22: TEXT LINE: 2 All Notes above apply Line 23: TEXT Line: 3 You need not place anything on these lines if your not using the Y switch in Line 18. Line 24: Text Line: 4 Line 25: Text Line: 5 We recommend a leading space before beginning Line 26: Text Line: 6 your text otherwise your sentences between Line 27: Text Line: 7 Text Lines will run together. Line 28: Security Level for your First Prompt We use different Prompt Lines for certain callers. Most systems do not do this so chances are you won't either. If you don't then Enter 0 here, If you do then enter the Security Level for the first Board command Prompt. Example: 6; This will display the prompt on Line 34 of the Configration file. For a caller with Security Level 6 Only. Line 29: Security Level for your Second Prompt Enter a 0 here if your not using Security Prompts Example: 20; This will diplay the prompt on Line 35 of the Configration file. For a caller with Security Level 20 Only. Line 30: Security Level for your Third Prompt. This one is a little different. It will display the Third prompt for any security level GREATER than this number. Enter a 0 here to disable this option. Example: 20; Levels 21 thru 255 will see Line 36 on the configuration file. ( Note how we have this example as the same number for Line 29. Line 31: This is the full Drive and Path of the File you want to use to display to the caller. Provided Line 18 is set to F * Registered Version Only Note: No @CODES@ are allowed, either color or Pcboard Variables, inside the text file. Example: J:\PCB\NEWS.TXT Line 32: This is the full drive and path of the file that you want to display randomly to the caller when line 18 is set to FR. Each sentence must be a complete, you can't continue to the next line or it will not make sense otherwise. File Example: Use the Zmodem protocol to speed up your transfers. The above was a complete sentence. Line 33: Reserved Line 34: This is the First Security Level Prompt If you entered 0 on line 28 simply place a ; on the first column of this line. If your not sure what this is, you will want to take a look at record number 396 of PCBTEXT This is done by running MKPCBTEXT and point to the location and name of your pcbtext file. If your not using anything special in this field copy the text displayed in this field to the config lines 35,36,37. The Generic PCBTEXT will show the following: (@X0C@TIMELEFT@@X0E min. left) @INCONF@Command Our examples below are slightly modified for our system, we use a separate PPE to display a different prompt for callers who have a different security level. Example: @X0F(@X0A@TIMELEFT@@X07 min left, @X0A@KBLEFT@@X07 K bytes left@X0F) @X0CExpired @INCONF@@X07; Line 35: This is the Second Security Level Prompt Example: @X0F(@X0A@TIMELEFT@@X07 min left, @X0A@KBLEFT@@X07 K bytes left@X0F) @X0CNew Caller @INCONF@@X07; If you entered 0 on line 29 simply place a ; on the first column of this line. Line 36: This is the Third Security Level Prompt If you entered 0 on line 30 simply place a ; on the first column of this line. Note: Anyone with a security Level greater than what you have entered on line 30 will be displayed this prompt. Example: @X0F(@X0A@TIMELEFT@@X07 min left, @X0A@KBLEFT@@X07 K bytes left@X0F) @X0C@INCONF@@X07; Don't forget ALL config lines MUST have the Semicolon ; immediately after your inputs. END OF THE CONFIGURATION FILE PART OF THE PROGRAM Line 37: This line will allow you to substitute the PCBTEXT line of your choice for the Non Expert mode. This line will override all the Prompts above. Good for displaying marqee in areas other than your Main Menu Screen. If you don't need this ability then simply place the semicolon at the beginning. Example: 224; Note: 224 is the Bulletin Display prompt Line 38 This line will allow you to substitute the PCBTEXT line that corresponds to the Expert Mode for a particular prompt, when used in confjunction with Line 37. You will have to do a little detective work to find the 2 prompts in PCBTEXT that go together. If you have entered something on line 37 and not on line 38 then line 37 will e displayed. Example: 611; Note 611 is the Expert Bulletin Display prompt. Line 39 If you are using the Pcboard Menu system, select Y to this option. Failure to do so will cause the Menu system Prompt to echo in your display screen. TIP: In your MNU setups you can avoid the display of the extra command prompt listed in your mnu, and use the one either in the default pcbtext or the ones you have specified in the marqee.cfg file. This is done by blanking out line 5 of your mnu and adding one blank space. This will cause PCBoard to display a blank character and complete the MENU display process. Line 40 If you are using the Pcboard Menu system and you need the HOTKEY option enabled you should select Y to this option. If you are not using Hotkeys then select N or leave it empty. Line 41-42 See the history.txt file for this information. This may be revised. Next we need to modify your BRDM screen. Make a backup copy of your BRDM screen first. You will need it later. At the bottom of your BRDM file on column 1 you will need to type the command to bring up the PPE this is done by typing: !J:\PCB\PPL\MARQEE\AQMARQEE.PPE Nothing else should come after the statement, and you MUST start it in the first Column or it will not run. For cosmetics on both your end and the callers end, your BRDM file should be no longer than 21 lines. It can be less if you like but never any greater Doing so will cause you to receive the more prompt which can become a nuisance. SEASONED SYSOPS: If your using Security specific BRDM screens, you may pass a path and name for the configuration file in your brdm for startup. If you do not specify a path then it will look in the location where the ppe is run and use marqee.cfg. This will allow you to run multiple copies for more security specific reasons based on Security BRDM screens and what you want to display to the caller. You could also run different config files for different screens. An example would be if you want to display a marqee in your bulletin screenm, and also have one displayed on your main menu as well. Example: Last line in BRDM !C:\PCB\PPL\MARQEE\AQMARQEE.PPE MARQEE.CFG WILL BE ASSUMED Example: Last line in BRDM21 BRDM Security level 21 specific menu !C:\PCB\PPL\MARQEE\AQMARQEE.PPE C:\PCB\PPL\MARQEE\MARQEE2.CFG MARQEE2.CFG will be used NOTE: To remain PCBoard compliant for people that use Robocomm, etc.. you should not run AQMARQEE on the Default text that comes with PCBoard. We recommend that you set up the default PCBoard language as Language number 2 take the BRDM screens that you made backup copies of and reassign them to Language number 2, with the appropriate language extension. This will prevent AQMARQEE from running on callers using Robocomm. For more information on setting up languages and dealing with the screens see the PCBoard Manual. Most people use Language Number 1 this is the one we recommend that you modify for your own systems needs and for installing AQMARQEE. Next we will need to modify your PCBTEXT file. To edit your PCBTEXT file. Type MKPCBTXT enter the location and name of your PCBTEXT. Use the F3 key to Jump to Record 333. This is the record you will need to edit. The field is rather small so insert the following. %J:\PCB\SYS\REC333 This is where all of my text is located at, insert your drive and appropriate location. Now save the file by hitting Escape. Next you will need to create and edit the file REC333 in the location where you pointed to it. INSERT @CLS@ at the very beginning, then insert the Text that you want to display to the caller afterwards, informing them that your here to chat. You may use the @OPTEXT@ in REC333 to display your name. For an example I will enclose my REC333 FILE. If you need to execute another PPE do this on the second line after you have completed a @CLS@. See the History file for the reason that this is necessary and the simple rules that you will need to follow during a SYSOP F10 chat. LIMITATIONS: 1: The program uses ANSI cursor positioning for its display if your caller does not have ansi capability the PPE will exit cleanly. 2: Only @FIRST@ , @FIRSTU@, @USER@, @USERU@, and @INTERNET@, @TIME@, @DATE@ are allowed to be used inside the text display fields. Do not attempt to use any other insertion parameters. 3: The PPE will not run for callers who are connecting at anything less than 9600 baud. The reason for this is when a caller hits ENTER or a command their modem has to complete displaying the text that it has sitting in the buffers. This makes it look as if the BBS is not responding so we have disabled it for low speed callers. If you have 2400 baud callers who are seeing AQMARQEE, you will want to look at the way your modem is returning its connect strings. Most modems can report either the actual connect speed ( which is the one you will want) or the locked port speed. If your modem is not reporting the correct speed of the caller, not only will AQMARQEE be unable to detect a slow modem, your transfer rate calculations will be way off, you will want to look at your modems configuration if this is a problem. STRANGE DISPLAYING: If your callers should mention that the text is scrolling and then suddenly stops or slows down for a second and then quickly continues, this is an indication that they may have some line noise. High speed modems are designed to stop and wait until a resend of correct data has been received, before it allows the data to be displayed. During your initial setup if your seeing Quick screen blinks over and over You should check Pcbsetup and make sure you have the Running Under a Network Switch turned ON. You don't need to be running a network for this switch to be on. If your a single node system without a network, I'd recommend you place the usernet file on a ramdrive, it will increase the programs performance and also prevent unnecessary disk lookups. DISPLAY ON/OFF: There are several ways that the caller will not see the Marqee, If they are in expert mode they will never see it unless they specifically call up the menu or take themselves out of Expert mode. Using a different Language where you have a language specific brdm screen that does not call up the PPE. OR Use NOMARQEE.PPE, This utility will allow the caller to turn the marqee display on or off. We've heard great praises about the marqee, but there's always a few that don't like changes. So we created this ppe to toggle it on and off. Place the command "MARQEE" or whatever you want to call it in your CMD.LST and point to NOMARQEE.PPE and select the desired security level. Since it is toggleable don't call it NOMARQEE. Since you want your callers to see the marqee I would not place this command on the menu screen, and only tell those who ask for it to be shut off. Use your own judgement as to whether you want to display this command or not. NOTE: VERY IMPORTANT DATA IN COMMENT FIELD #2 COULD BE LOST. DO NOT USE NOMARQEE.PPE IF YOU ARE USING COMMENT FIELD 2. We are using PCBoard's sysop comment field number 2, to place a - character that we look for each time Aqmarqee is run. If you are storing any information in this field the NOMARQEE.PPE will not work. Comment 2 field has to be blank. We can make a custom version using one of the Pcboard Note fields if you need it. Due to the need for access speed of AQMARQEE we felt that having a separate file with the caller's selection would hinder the program. FINISH: Well that should just about cover the installation. Bring up your board and check it out first before allowing callers into your system. Keep reading there is one more utility to go over. see below. REGISTRATION: Registering your copy will remove the Evaluation Display on AQMARQEE, and allow you to use the File Display options, and the no BBS name at the end of the text display. Other than that the program is fully functional. A lot of work has gone into writing the program and getting the displays to work as seamless as possible. You may evaluate the program for 2 weeks. After such time you will need to register the program or stop using it. You may not give your registration code out to others. Please see the enclosed registration form. Registrations are NOT transferrable. Our BBS Number is 708-820-8344 You may register online by calling our support board. Once online type, MARQEEREG. This will place you in the registration area. Follow the instructions once your inside. Registration's are processed within 1 to 24 hours. You will need to call back in to obtain the registration number. This is done by reentering MARQEEREG, if it has been 24 hours and you have not been given your registration code, please use the "C" command to drop us a note just in case we missed you. You may also use the Registration Form enclosed and mail in your registration. The address is located in the registration form. - An added ppe utility. NOMARQEE.PPE, This utility will allow the caller to turn the marqee display on or off. We've heard great praises about the marqee, but there's always a few that don't like changes. So we have created a new ppe to toggle it on and off. Place the command "MARQEE" or whatever you want to call it in your CMD.LST and point to NOMARQEE.PPE and select the desired security level. Since it is toggleable don't call it NOMARQEE. Since you want your callers to see the marqee I would not place this command on the menu screen, and only tell those who ask for it to be shut off. NOTE: VERY IMPORTANT DATA IN COMMENT FIELD #2 COULD BE LOST. DO NOT USE NOMARQEE.PPE IF YOU ARE USING COMMENT FIELD 2. We are using PCBoard's sysop comment field number 2, to place a - character that we look for each time Aqmarqee is run. If you are storing any information in this field the NOMARQEE.PPE will not work. Comment 2 field has to be blank. We can make a custom version using one of the Pcboard Note fields if you need it. Due to the need for access speed of AQMARQEE we felt that having a separate file with the caller's selection would hinder the program.