 
+-----------------------------------------------------------------------------+
|Synchronet DoorStats v1.0 Copyright 2009  Philip Brown  www.flamingstar.com|
+-----------------------------------------------------------------------------+

This program was written to read the Synchronet log files and create a bulletin
showing monthly, and yearly door usage.

This program was written to run on MSDOS and Windows platforms.  I have tested
this program on Windows vista Home Premium and Windows XP Home edition running 
Synchronet BBS Software v3.15a.

Below is a example of the monthly.asc file it creates.

The Flaming Star BBS: March 2009 Door Stats
 
   Ŀ
   # Times    Door Name                            
   Ĵ
        1  Domain Poker                           
        1  Door Mania                             
        1  DoorMUD v0.99                          
        1  Dragon's Hoard                         
        1  Flip the Bits                          
        1  Fresh Water Fishing                    
        1  Legend of the Red Dragon               
   
 
Bulletin Created: 03/21/09 18:42:32
Synchronet DoorStats v1.0 Copyright 2009  Philip Brown  www.flamingstar.com 


FILES USED BY THIS PROGRAM:

SYNCDOOR.EXE	Program used to create bulletins.
SETUP.EXE       Program used to setup bulletin paths, colors.
SETUP.DBF       Data file used to store program information.
SYNCDOOR.DBF    Temporary file used to read log file.
WORK.DBF        Temporary file used to read log file.
DOORS.BAT       Batch file to use when setting up a event.

TEMP FILES CREATED/DELETED BY THIS PROGRAM:
TMP.DBF         Temporary file used by SYNCDOOR Program. 
DOORTMP.NTX     Temporary file used by SYNCDOOR Program. 
CALLERS.LOG     Temporary file used by SYNCDOOR Program. 
TMP.NTX         Temporary file used by SYNCDOOR Program. 
WORK.NTX        Temporary file used by SYNCDOOR Program.
LOCKED.MEM      Temporary file used by SYNCDOOR Program.


FILES CREATED BY THIS PROGRAM:

MONTHLY.ASC 	.ASC Bulletin created by SYNCDOOR Program.
MONTHLY.ANS     .ANS Bulletin created by SYNCDOOR Program.
MONTHLY.HTM     .HTM Web Bulletin created by SYNCDOOR Program.
YEARLY.ASC      .ASC Bulletin created by SYNCDOOR Program.
YEARLY.ANS      .ANS Bulletin created by SYNCDOOR Program.
YEARLY.HTM      .HTM Web Bulletin created by SYNCDOOR Program.

EXECUTING THE PROGRAM:

Step 1:

Run the setup.exe program and it will give you 5 menu choices.

1) Log Path                      Path of the log file.

2) Bulletin Color Selection      Menu with 2 boxes (Monthly, Yearly)

        After you select one of the three boxes, it will give you a
        selection of color choices, using your arrow keys, move to the
        color and press enter to make your choice and above the choices
        it will show your selection as you try other colors.
        When finished, select 'Exit Color Selector' and then pick another
        box and like above, pick your colors.  When done select
        'Exit Color Selection' and it will return to the menu.

3) Exclude Certain Doors in Bulletins    Exclude - Yes or No.

        If you select YES, then it will give you 15 lines you can
        add doors/programs to exclude from your bulletins.

4) BBS Name                      Puts your BBS name on Bulletins.

5) Exit Setup Program            Exit Program.

        Before exiting, check the values and colors you have selected.


Step 2:

Run the syncdoor.exe program and it will read the setup data file for the
information it needs to process the log and create both ascii and ansii
bulletins.


If you run the syncdoor.exe program without running setup.exe, you will get
the following error:

# Please run setup first.  Program exiting...


Once you have ran the setup program and gave it the information it needs, then
run "syncdoor monthly" or "syncdoor yearly" (no quotes), and it will read the 
setup information and process the log and create both ascii/ansi/html bulletins.

The syncdoor program has 2 command line options you can use.

For Example:

syncdoor monthly - This program creates a bulletin on monthly door usage.

syncdoor yearly  - This program creates a bulletin on yearly door usage.


MODIFYING BULLSEYE.CFG/BULLSEYE.ASC:

To show the new bulletin, you will need to modify the bullseye.cfg file located
in the sbbs\text folder.

For Example:

0
../text/system.msg
../text/newuser.msg
../text/sbbs.msg
../docs/dove-net.txt
c:/sbbs/syncdoor/monthly.ans
c:/sbbs/syncdoor/yearly.ans

Then modify the bullseye.asc file in the sbbs\text folder.

For Example:

l0nc4k0
4c  hyBulletins  nk40
4ckb0

 hy1 ngStatistics for h@BBS-L....................................@nb
 hy2 ngNew user instructions                                     b
 hy3 ngAbout this version of Synchronet BBS Software             b
 hy4 ngWhat is DOVE-Net?                                         b
 hy5 ngMonthly Door Statistics                                    b
 hy6 ngYearly Door Statistics                                     b
n

LOGON/TIMED EVENTS:

Depending on when you want to execute SYNCDOOR, you can setup events to run 
them for you.


Below is an example of a timed event. 

+[][?]--------------------------------------------------------------+
                          EVENT Timed Event                         
--------------------------------------------------------------------
 Internal Code                   SYNCDOOR                          
 Start-up Directory              c:\sbbs\syncdoor                  
 Command Line                    doors.bat                         
 Enabled                         Yes                               
 Execution Node                  4                                 
 Execution Days of Month         Any                               
 Execution Days of Week          All                               
 Execution Frequency             12 times a day                    
 Requires Exclusive Execution    No                                
 Force Users Off-line For Event  No                                
 Native (32-bit) Executable      No                                
 Use Shell to Execute            No                                
 Background Execution            Yes                               
 Always Run After Init/Re-init   No                                
+--------------------------------------------------------------------+

You can create a batch file as shown below. (change paths to match your BBS)

	cd\sbbs\syncdoor
	syncdoor monthly
	syncdoor yearly
	cd\


If you would like to copy the .HTM Bulletins to place on your web site, then 
add the following 2 lines to your doors.bat file.

Make sure you change the paths to match your BBS Configuration.

copy yearly.htm c:\sbbs\web\root\doorsyr.htm
copy monthly.htm c:\sbbs\web\root\doorsmo.htm


Next you will need to add HTML code to the web files.  For example, you could
add the following to your MAIN.INC file located in the 
c:\sbbs\web\templates\default folder.  You can add the code to any HTML file
you would like.

Example:

    Online BBS Statistics:<br><br>
    <a target = "new" href="doorsmo.htm">Door Stats (Monthly)</a> or 
    <a target = "new" href="doorsyr.htm">Door Stats (Yearly)</a><p>


CONTACT INFORMATION:

+-----------------------------------------------------------------------------+
  By Philip Brown  The Flaming Star BBS  http://www.flamingstar.com        
+-----------------------------------------------------------------------------+

    Email: pbmountaincat@flamingstar.no-ip.info
   TELNET: telnet://flamingstar.no-ip.info
   TELNET: telnet://flamings.synchro.net
   TELNET: telnet://flamingstar.bbsdatabase.com
      FTP: ftp://flamingstar.no-ip.info
      WWW: http://www.flamingstar.com

NOTES:

If you like this program and want to use it on your Synchronet BBS, please
send me a email, or logon the BBS and drop me a note so I know who is using 
this program.  

If you have any suggestions, questions, or ideas for a new bulletin program, 
please send me a email.   I would like to hear from you.

Thanks,
Philip Brown aka Pbmountaincat
Flaming Star BBS
+-----------------------------------------------------------------------------+
