Beijing Paradise BBS Backup

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

/ Beijing Paradise BBS Backup / PARADISE.ISO / software / BBSDOORW / RALM02A.ZIP / RALM.DOC < prev next >

Wrap

Text File | 1996-09-03 | 13.4 KB | 260 lines

┌────────────────────────────────────────────────────────────────────────────┐ ░░▒▒▓▓█ Break Point Productions 1996 Presents █▓▓▒▒░░ └────────────────────────────────────────────────────────────────────────────┘ ▀▀▀▓▄▄ ▄▀ ▄▓█▄ ▄▀ ▄ ▄██▄░▀██▓▄ ▄▓█▌ ▀████▓ ▄▓█▌ ▐▓▄ ▒▀ ▀░░░░░███▓ ▄████▓ ████ ▄████▓ ▄██▓█▌ ░░▐▒▒▄░ ░░▌ ░█░▀ █▓▌ ▐███ ░█░░███░░░▐█▓ ░▐▓▓▐▒▌▒▀ ░░░░████▌ ░░▌ ░░░░▀ ░░█▀ ██▓ █▓▀ ▀▓▓▄ ▐▒▒▒▀ ▐░░░ ▒▒ ▐▒▒▒ ░▒▀ ▄░░░ ▀███▄ ▓███ ▓▒▌░ ░▒▒▒ ▄ ▓▌ ▄▓█▄ ▐▓▒▌░ ▄▓▓▓▀ ▀▀ ▀▀▀▀ ▓▄ ▄▓▀ ▀ ▀▄▄████▀ ▀▀ ▀▀▀ Remote Access Lightbar Menus v0.2Alpha PUBLIC ALPHA RELEASE, For RemoteAccess 2.50 ONLY Compiled in Turbo Pascal v7.0 Using the Break Point Engine ┌────────────────────────────────────────────────────────────────────────────┐ ░▒▓█ Version Updates █▓▒░ └────────────────────────────────────────────────────────────────────────────┘ This is the second public release of RaLM, Since v0.1A the following changes have been made : 1. RA-Language Support added, thanx to Chris - appreciated dude q:) 2. Optimized code, loading and program operation is noticably faster. 3. Ctrl-Break Checking disabled. 3. Some minor bug fixes. ┌────────────────────────────────────────────────────────────────────────────┐ ░▒▓█ Upgrading from v0.1a to v0.2a █▓▒░ └────────────────────────────────────────────────────────────────────────────┘ This couldnt be easier, simply replace your old RALM.EXE with the new one. ┌────────────────────────────────────────────────────────────────────────────┐ ░▒▓█ Copyright Notice and Program Disclaimer █▓▒░ └────────────────────────────────────────────────────────────────────────────┘ I (Slayer of Break Point BBS) make no warranty of any kind, expressed or implied, including without limitation any warranties of merchantability and/or fitness for a particular purpose. I shall not be held liable for any damages, whether direct, indirect, special or consequential arising from the failure of this program to operate in the manner desired by the user. I shall not be held liable for any damage to data or property which may be caused directly or indirectly by the use of this program. In no event will I be held liable for any damages, including (but not limited to) any lost profits, lost savings, or other incidental or consequential damages arising out of the use -- or the inability to use -- this program, or for any claim by any other party. The following programs mentioned in this documentation are Copyright of their respective authors. They are listed in no particular order: RaLM - Copyright Break Point Productions 1996 RemoteAccess - Copyright Wantree Development & Andrew Milner X00 - Copyright Raymond L. Gwinn BNU - Copyright David Nugent and Unique Computing Pty Limited Turbo Pascal - Copyright Borland International ┌────────────────────────────────────────────────────────────────────────────┐ ░▒▓█ Basic Feature Overview █▓▒░ └────────────────────────────────────────────────────────────────────────────┘ ■ RaLM will easily do the following : - Quick Login - Upload Manager (Public/Sysop Upload etc) - Lightbar Logoff - Display ANSi/AVT Files to User - Execute Doors - Main/File/Message Menu etc ■ Quick and easy setup ■ Associate hotkeys with lightbars ■ Menu Position Saving ■ Minimum/Maximum Security and Flag checking definable for each lightbar ■ Stuffs hotkeys into Sysops keyboard ■ Exceptional keys definable (ie. keys that will terminate the door) ■ Userdoes support for each menu ■ No stupid delays or beeps ┌────────────────────────────────────────────────────────────────────────────┐ ░▒▓█ Break Point Engine Features █▓▒░ └────────────────────────────────────────────────────────────────────────────┘ ■ Internal ANSi/AVT decoding for local screen ■ ANSi Nesting and RemoteAccess Language Support ■ Complete RemoteAccess 2.50 Control code Support ■ RA-Alike Statusline, User Editor, IEMSI/Line by Line chat etc ■ Built in Carrier, timelimit, inactivity and online message watchdog ■ Complete RemoteAccess Logging and Userdoes Support ■ Built-in Engine Setup Utility for optimizing your bPP Door ■ Sysop can terminate door with ALT-X - no changes will be written ┌────────────────────────────────────────────────────────────────────────────┐ ░▒▓█ Program Description █▓▒░ └────────────────────────────────────────────────────────────────────────────┘ RaLM is surely not the first but the most practical and useful lightbar utility for RemoteAccess 2.50. You can define lightbar driven menus that will guide your users through your BBS very comfortably using their cursor keys or associated hot-keys (if enabled). This program was not designed as a complete lightbar supplement. More specifically it was written so you could improve your BBS by adding a lightbar: logoff, quick-login and upload selection for example. To completely lightbar a BBS would be too time consuming and would reduce performance too much, probably resulting with complaints from your users. ┌────────────────────────────────────────────────────────────────────────────┐ ░▒▓█ How it works █▓▒░ └────────────────────────────────────────────────────────────────────────────┘ Operation of RaLM is really quite simple. All it does is 'stuff' the associated key with the selected lightbar-item into the sysops keyboard and terminates. From here RemoteAccess thinks that the user pressed the key and takes the appropriate action. NOTE : RaLM will NOT function if the user doesn't have Hot-Keys turned ON in his/her user record. This is not really any great requirement - all you need do is set RaConfig > Options > New Users > Hotkeys, to Yes. After that all new users that logon to your BBS will have hotkeys on and will be able to use RaLM. ┌────────────────────────────────────────────────────────────────────────────┐ ░▒▓█ Installation/Setup █▓▒░ └────────────────────────────────────────────────────────────────────────────┘ Setup is really quite simple. After going through the command overview table and looking at the example setup file (EXAMPLE.RAM - Included in this ZIP) I am sure you will have no troubles at all. q:) The first step is to setup your desired menu with hotkeys in RemoteAccess. From here RaLM should be executed in your Selected .MNU file with a type 7 (Execute sub-program) door shell in this format [Drive & path to RALM.EXE] RALM.EXE [Config File - NO FILESPEC] *X *M Example: C:\RA\RALM\RALM.EXE EXAMPLE *M EXAMPLE Is the Configuration File, RaLM assumes that the file exists in the same directory as RALM.EXE and that it has the filespec '.RAM'. This file must be plain ASCII with <CR> terminated lines, I reccomend using DOS's EDIT.COM to write the configuration files. *M Instructs RemoteAccess to Swap out of memory before loading RaLM. Again this is optional, but I reccomend using it as it ensures that there will be enough memory to load RaLM, try loading RaLM without it - if okay you might want to continue without this parameter as doing so will dramatically increase load-time. There are two main parts to a configuration file, the 'Config' block and the 'Item' block(s). Blocks are formatted like this : ----cut------cut------cut---- Config [ Commands ] End Item [X-Pos of the Item],[Y-Pos of the Item] [ Commands ] End ----cut------cut------cut---- ┌────────────────────────────────────────────────────────────────────────────┐ ░▒▓█ Commands Overview █▓▒░ └────────────────────────────────────────────────────────────────────────────┘ Note : '*' Indicates that the command is optional. Within the 'Config' block : ANSI=[Text] : Is the ANSi/AVT File to display as the background of the menu. COLOURS=[Sel_Fg],[Sel_Bg],[UnAvail_Fg],[UnAvail_Bg] : Defines the Colours to be used by RaLM for the Selected menu item. Sel_Fg & : Is the Foreground/Background Colour Sel_Bg when the item is Availible to the User. ie. When He/She meets the Security and Flag requirements. UnAvail_Fg: Is the Foreground/Background Colour & when the item isn't Availible to the UnAvail_Bg User. ie. When He/She doesnt meet the Security and Flag requirments. HOTKEYS=[On/Off] : Enables/Disables the use of Hot-Keys. SAVEPOS=[On/Off] : Enables/Disables Menu-Position saving. * EXEMPT=[Text] : Defines the Key(s) that will be 'stuffed' into the keyboard and terminate the program. * MINSEC=[0-65535] : Defines the default Minimum Security for each item. * MAXSEC=[0-65535] : Defines the default Maximum Security for each item. * FLAGS=[Text] : Defines the default Flags required for each Item. Flags should be in this format : [Flag][+/-], Example: FLAGS=A1+B2-C2-. In the example the user Must have Flag A1:Set and Flags B2 & C2:Not Set. For more information on flags refer to RA.DOC. * USERDOES=[Text] : USERDOES info to be put into the USERDOES.x (where x is the node number) so other users get a detailed description of what the user is doing. * STARTAT=[Char] : Is the letter of the item where RaLM will start. * INFOSET=[X-Pos],[Y-Pos],[Fg-Colour],[Bg-Colour],[Field Len] : Defines the info field to be used by this menu. This must be specified if you wish to use item-info. X-Pos : Is the X Position of the field. Y-Pos : Is the Y Position of the field. Fg-Colour : Is the foreground colour of the field. Bg-Colour : Is the background colour of the field. Field Len : Is the length of the field, set to 0 if you dont want a fixed length. Within the 'Item' block : TEXT=[Text] : Is the actual text to be displayed when the item is selected. HOTKEY=[Char] : Is the hotkey of the item, this is the key that will be stuffed into the local keyboard-buffer when the item is selected. * INFO=[Text] : Is the text to be displayed in the info-field when the item is selected. * MINSEC=[0-65535] : Defines the Minimum Security for the item. * MAXSEC=[0-65535] : Defines the Maximum Security for the item. * FLAGS=[Text] : Defines the Flags required for the Item. Flags should be in this format : [Flag][+/-], Example: FLAGS=A1+B2-C2-. In the example the user Must have Flag A1:Set and Flags B2 & C2:Not Set. For more information on flags refer to RA.DOC. * DISPLAY=[Text] : Is the Filename (with no filespec) of a ANSi/AVT/ASC file to be displayed when the item is selected. * SPAWN=[Text] : Is the command line to be executed when the item is selected. RemoteAccess command line macros valid. ┌────────────────────────────────────────────────────────────────────────────┐ ░▒▓█ Feedback and Bug Reports █▓▒░ └────────────────────────────────────────────────────────────────────────────┘ I am interested to see what doors people want, leave me email and I will see what I can do. I can be contacted on the internet at: cyoung@ihug.co.nz or, cyoung@sinesurf.co.nz Please take note that this is NOT my address, so it will take several days for me to get the mail before I can think about replying - BE PATIENT! A few points when bug reporting, explain the circumstances exactly and note the "Runtime error" generated by RaLM otherwise your bug report will be pointless. ┌────────────────────────────────────────────────────────────────────────────┐ ░▒▓█ Joining Break Point Productions █▓▒░ └────────────────────────────────────────────────────────────────────────────┘ If you would like to become part of bPP then simply leave me email at the above internet address along with some info about yourself and how you would like to join. (ie. ANSi artist, coder etc) New members are welcome and needed! .: Updates and other Break Point Productions are available at :. .: Break Point BBS +649-473-9613 7 days :.