Top Users
Version 0.250504

by Craig Hendricks
codefenix@conchaos.synchro.net

ConstructiveChaos BBS:
  https://conchaos.synchro.net
 telnet://conchaos.synchro.net
    ssh://conchaos.synchro.net



Description:

This is a simple mod to display the top 5 users for the lifetime of your BBS
in 6 different categories.

Unlike the old "topfives" script, this is extremely simplified, and designed
to be run on-demand and not require a nightly event to extract stats from
Synchronet's log files.



Why should I use TOPUSERS when there's TOPFIVES?

(ignore this section if you've never heard of topfives.js)

topfives.js needs to be run on a nightly basis to extract data from
Synchronet's log files. This can take a long time depending on how long your
BBS has been running and/or how active your BBS is. Furthermore, if a log file
becomes unexpectedly corrupted, this can impact topfives' ability to work
properly.

In short, topfives.js needs to be overhauled with these things in mind.
topusers.js is offered as a simplified alternative in the meantime.

Please consider topfives a thing of the past and use this as an alternative.



Basic Instructions:

1. Create the path: /sbbs/xtrn/topusers

2. Extract topusers.js and topusers.msg into it.

3. Copy the topusers.msg file into your /sbbs/text/menu path and rename
   it to the file you want shown during login (i.e.: logon1.msg, logon2.msg,
   etc.).

   Refer to https://wiki.synchro.net/config:text_files to understand how
   display files get shown during logon.

4. Use PabloDraw to edit the .msg file to your liking, being sure to keep
   @CLEAR@ on line #1 by itself, and the call to the script on line #24 by
   itself: @EXEC:../xtrn/topusers/topusers.js@

   Your own BBS's name comes pre-embedded into the .msg file using the message
   variable @BBS@. Refer to https://wiki.synchro.net/custom:atcodes for more
   info.



Usage:

   Every time the .msg file is displayed, the topusers.js script gets called,
   reading the lifetime user stats which Synchronet tracks automatically. It
   then ranks them and shows the top five users in six categories.

   Sysop stats and guest stats are excluded from the list in order to prevent
   them from becoming the "top user" in any category. Users who have been
   deleted or marked inactive are also similarly hidden from the lists.



Limitations:

   The user stats tracked by Synchronet are somewhat limited, therefore the 6
   categories are limited to top callers, top posters, top downloaders (files
   and kbs), and top uploaders (files and kbs), and are not customizable.

   The stats are for the lifetime of the BBS, and aren't limited by month, or
   year, etc.



Version History:

v 0.20250504 - May 4, 2024:

  + Added a console.gotoxy at the end of main, to place the cursor at the 
    bottom of the screen when the script completes.
  

v 0.20250422 - April 22, 2024:

  + Initial version.
