home *** CD-ROM | disk | FTP | other *** search
/ ftp.wwiv.com / ftp.wwiv.com.zip / ftp.wwiv.com / pub / EVENTS / BREAK10.ZIP / BREAKST.DOC < prev    next >
Text File  |  1995-11-08  |  13KB  |  254 lines
  1. ╔───────────────────────────────────────────────────────────────────────────╗
  2. ║  UNiT              ■ What The Hell Is BreakStat Anyway? ■           UNiT  ║     
  3. ╚───────────────────────────────────────────────────────────────────────────╝
  4.  
  5.    BreakStat is a revolutionary logon event.  Okay, it's not.  But it is
  6.    a great way to let the users see their stats and the board's activity 
  7.    for the day, including uploads, posts, and more.  It's a great ANSI done
  8.    by Chipset of UNiT which makes it look so DAMN nice. =-)   The -ONLY-
  9.    thing I do ask of you if you use this is to Email me at one of the
  10.    addresses at the bottom so I know this is a useful program.  I will keep
  11.    you on a list and as new versions become available I will let you know.
  12.    Please do let me know, that's important to me.   Donations are accepted;
  13.    I know that might sound weird but it lets know I should keep upgrading
  14.    and releasing my programs.  Or if you use the program fill it in and 
  15.    send it to me, just so I know you use it and to get updates.  
  16.    (Check DONATE.TXT) Thanks!
  17.  
  18. ╔───────────────────────────────────────────────────────────────────────────╗
  19. ║                     ■ Installation, Difficult (Joke) ■                    ║     
  20. ╚───────────────────────────────────────────────────────────────────────────╝
  21.  
  22. ─[ Logon Event ]─
  23.    
  24.    If you want BreakStat to ask your users "Do you want to view your stats?"
  25.    add this to your LOGON_CMD in WWIV.INI, or in your batch file called from       
  26.    LOGON_CMD put:
  27.                                                 "BREAKST %1"
  28.  
  29.    If you -DON'T- want BreakStat to ask your users if they want to view their
  30.    stats, and just to display their stats, add this to your LOGON_CMD in
  31.    WWIV.INI of your batch file ran from WWIV.INI:
  32.  
  33.                                                 "BREAKST %1 /NOASK"
  34.  
  35.    The argument needed is the CHAIN.TXT dropfile, so you might, pending 
  36.    certain circumstances need to do this:
  37.                                                 "BREAKST C:\WWIV\CHAIN.TXT /NOASK"
  38.                                               or
  39.                                                 "BREAKST C:\WWIV\CHAIN.002 /NOASK"
  40.  
  41.    In other words, point BreakStat to CHAIN.TXT.  Make sure you use the 
  42.    correct path for your system.  While in WWIV.INI, make sure you add
  43.    the NOPAUSE flag to the SPAWNOPT[LOGON] line; in other words, make it look
  44.    like this:
  45.  
  46.                        "SPAWNOPT[LOGON] = SHRINK, COMIO, INTERNAL, NOPAUSE"
  47.  
  48.    The "/NOASK" flag is pretty self-explanitory, it won't ask if you want
  49.    to view your stats, it just will.  When running BreakStat as a chain, you
  50.    would always want to use this option, why else would they have run the 
  51.    chain.  
  52.  
  53.    If you have registered WWIV, which you all should have, then it would be
  54.    wise to make a source code modification taking out the stock logon 
  55.    stats that look ugly.  Sorry Wayne, but it's true.  To do this, follow 
  56.    these easy instructions:
  57.  
  58. ─ Step 1 ─       
  59.  
  60.   file        : LILO.C
  61.   function    : logon()
  62.   objective   : strip logon statistics
  63.    
  64.         ─═─ Find "if (live_user) {" around line 585.  It should be the fourth   
  65.             "live_user" you should run into.  Right above it, there are calls 
  66.             to stuff_in and extern_prog().  
  67.    
  68.     Delete From, And Including :
  69.      
  70.                 if (live_user) {
  71.                      nl();
  72.  
  73.                        outstr(get_string(237));
  74.  
  75.                  ─ DOWN TO AND INCLUDING ─
  76.  
  77.                       pl(get_string(1170);  
  78.                   }
  79.               }  
  80.               npr("%s%d\r\n", get_string(1171), instance);
  81.  
  82. ─ Finished ─   
  83.  
  84.    I think that's easy enough, if you still need help feel free to contact me
  85.    at one of the addresses at the end of this DOC.
  86.  
  87. ─[ Chain ]─
  88.  
  89.    A. Description     :  BreakStat v1.0
  90.    B. Filename        :  BREAKST.EXE %1 /NOASK 
  91.    C. SL              :  10  
  92.    D. AR              :  None.
  93.    E. ANSI            :  Required  
  94.    F. Dos Interrupt   :  USED
  95.    G. 300 Baud        :  NOT Allowed
  96.    H. Shrink          :  Yes  
  97.    I. Disable Pause   :  Yes
  98.    J. Local Only      :  No
  99.    K. Multi User      :  Yes
  100.    L. Registered      :  AVAILABLE 
  101.    M. Usage           :  0  
  102.    N. Age Limit       :  0 - 255
  103.    O. RIP mode        :  Optional  
  104.  
  105. ╔───────────────────────────────────────────────────────────────────────────╗
  106. ║     How to use the PipeCodes (This will be implemented in Version 1.1)    ║
  107. ╚───────────────────────────────────────────────────────────────────────────╝
  108.  
  109.    PipeCodes allow you to use -ANY- ANSi you want.  I got the idea for this
  110.    feature from Frank 1@1.DigiNet who uses this with his program, Digital
  111.    BBSList.  With the PipeCodes, you create/edit your ANSi and where you
  112.    want to put the different fields (User Name, Sex/Age, Local Posts Today,
  113.    etc.) you put the PipeCode.  Here is how to do it:
  114.  
  115.    ─═─  In your ANSi, you put a "|" and then the letter corresponding to the
  116.         field you want placed there.  For example, if you put a "|N" in your
  117.         ANSi, instead of printing the "|N" it would place your SystemName.
  118.         There is a list of the different fields you can use at the end of
  119.         this section.  
  120.    
  121.    ─═─  How does it do this?  You don't -HAVE- to use ANSi, but that's how 
  122.         the best way to do it.  BreakStat will read every two characters in
  123.         BREAKST.ANS and if it's a PipeCode, it will look it up in the "index"
  124.         and print out the appropriate code.  If it does not begin with a "|"
  125.         it will just print out the ANSi.  You will -NOT- notice a difference
  126.         if you printed out a file without PipeCodes.  
  127.    
  128.    ─═─  If you need to see how this is all done, refer to the included ANSi
  129.         BREAKST.ANS.  Load it up an ANSi Editor, Or "type" it.  Loading it
  130.         in BreakStat will disable you from seeing the PipeCodes as it  
  131.         interprets them.
  132.  
  133.  < ─────────────────  For Version 1.1 and Above Only  ──────────────────── >          
  134.  
  135.           ┌─────────────────────────────────────────────────────────┐
  136.           │      Pipe Code              What Field it Represents    │       
  137.           ├────────────────────────┬────────────────────────────────┤
  138.           │         A              │    Name/Handle                 │
  139.           │         B              │    Real Name                   │    
  140.           │         C              │    User's Phone Number         │  
  141.           │         D              │    Street Address              │
  142.           │         E              │    City                        │    
  143.           │         F              │    Two-Letter State Abbr.      │
  144.           │         G              │    Zip-Code                    │
  145.           │         H              │    Last Date On                │
  146.           │         I              │    Sysop's Note On User        │     
  147.           │         J              │    User's Sex                  │
  148.           │         K              │    User's Age                  │         
  149.           │         L              │    Security Level              │      
  150.           │         M              │    Download Security Level     │
  151.           │         N              │    Number of Messages Posted   │ 
  152.           │         O              │    Emails Sent                 │     
  153.           │         P              │    Feedback Sent               │      
  154.           │         Q              │    Files Uploaded              │ 
  155.           │         R              │    Files Downloaded            │       
  156.           │         S              │    Amount Of Logons            │       
  157.           │         T              │    Time Left Today             │
  158.           │         U              │    System Name                 │ 
  159.           │         V              │    System Phone                │ 
  160.           │         W              │    Sysop's Name                │
  161.           │         X              │    Required UL/DL Ratio        │ 
  162.           │         Y              │    Post/Call Ratio             │
  163.           │         Z              │    Max Mail Waiting            │    
  164.           │         !              │    Local Posts Today           │  
  165.           │         @              │    Current Number of Users     │
  166.           │         #              │    Messages Posted Today       │ 
  167.           │         $              │    Version of WWIV             │     
  168.           │         %              │    Days BBS Have Been Active   │ 
  169.           │         ^              │    -BOARD- WWIV Reg Number     │
  170.           │         &              │    Chains User Has Run         │ 
  171.           │         *              │    Illegal Logons              │ 
  172.           │         (              │    Number of Mail Waiting      │
  173.           └────────────────────────┴────────────────────────────────┘
  174.  
  175.  < ─────────────────  For Version 1.1 and Above Only  ──────────────────── >
  176.  
  177. ╔───────────────────────────────────────────────────────────────────────────╗
  178. ║                               ■ Credits ■                                 ║     
  179. ╚───────────────────────────────────────────────────────────────────────────╝
  180.     
  181.    ─ Albert Vernon and Joshua Hines For Giving Me A Direction To Start With.
  182.    
  183.    ─ Jon Rickher, Tolkien, For his spin() function that makes the pause look
  184.      so darn good =-)
  185.    
  186.    ─ Wayne Bell for creating the best BBS software, and multitasking 
  187.      functions.
  188.    
  189.    ─ Frank Reid for running such a great board that I call and leech from
  190.      daily.  
  191.    
  192.    ─ Chipset of UNiT For The Greatest Looking ANSi which makes it so darn
  193.      attractive.
  194.    
  195.    ─ The Lich of Barrel Of Monkeys BBS for testing it every five minutes =)
  196.    
  197.    ─ Z-Man @8325.WWIVnet for enhancing the animated pause
  198.    
  199.    ─ Frank 1@1.DigiNet for his help with the Pipe Codes. Big Clap for him!
  200.    
  201. ╔───────────────────────────────────────────────────────────────────────────╗
  202. ║                           ■ Hopeful Upgrades ■                            ║
  203. ╚───────────────────────────────────────────────────────────────────────────╝
  204.  
  205.    I would like to add configurable messages to say if the Sysop is available
  206.    and not available.  I know it's easy I just haven't felt like doing it. =)
  207.    I am looking forward to implementing random ANSi screens also.  I am
  208.    going to wait for this release to be out before I start working on that
  209.    just to make sure everything goes right.  PipeCode Support should be in
  210.    the following version along with the use of multiple ANSiS, which goes
  211.    along with the random ANSiS.
  212.  
  213. ╔───────────────────────────────────────────────────────────────────────────╗
  214. ║                        ■ Legal Crap, Bear With Me ■                       ║
  215. ╚───────────────────────────────────────────────────────────────────────────╝
  216.  
  217.    The pkZIPed archive contains:
  218.        
  219.         BREAKST  .EXE  ─  The actual program, the executable file
  220.         BREAKST  .DOC  ─  The documentation accompaning the program
  221.         PIPES    .TXT  -  Text File of PipeCodes
  222.         BREAKST  .ANS  ─  The ANSI screen by UNiT 
  223.         BREAKST2 .ANS  -  Complimentary ANSI, Rename to BREAKST.ANS For Use
  224.         FILE_ID  .DIZ  ─  The description file used on BBSs
  225.  
  226.    This program, BreakStat by Elliot Tobin may -NOT- be distributed if the 
  227.    archive is -NOT-EXACTLY- like above.  You -MUST- keep the archive name
  228.    the same, BREAKxx.ZIP and can't make any changes in the files, of which
  229.    are included above.  By using this program, you're the one taking the 
  230.    responsibility if it harms you, your computer, or whatever in any way.  
  231.    Well, that is except something good comes out of it, like money =-)  By
  232.    using it, you're accepting the consequences that -COULD- happen.  In 
  233.    other words, use at -YOUR- own risk.  There are -no- warranties, 
  234.    expressed or implied towards the performance or towards damages.
  235.  
  236. ╔───────────────────────────────────────────────────────────────────────────╗
  237. ║                         ■ Where You Can Reach Me ■                        ║
  238. ╚───────────────────────────────────────────────────────────────────────────╝
  239.  
  240.    WWIVnet        - 1@8319
  241.    TerraNET       - 1@4064
  242.    IceNET         - 1@4065
  243.    DigiNet        - 1@9
  244.    InterNet       - 1-4064@tnet.bluethun.com  =  Thanks to JAFO!
  245.    Breakaway BBS  - (410) 381.7311 [ASV/GSA] USR 28800 v.34/v.FC
  246.  
  247. ─[UNiT]─[─═─]───────────────────────────────────────────────────────────────
  248.  
  249. BreakStat is Copyright (c) 1995 by Elliot Tobin aka ELBOW
  250.  
  251. BTW- Go get the new Smashing Pumpkins Double-Album, Mellon Collie And The
  252.      Infinite Sadness; it is -SO- awesome.
  253. ─[UNiT]─[EOF]───────────────────────────────────────────────────────────────  
  254.