Changeset 834 for trunk/modules/extra/stats.tcl

Timestamp:

07/29/07 17:18:19 (18 months ago)

Author:

james

Message:

beautify the sample config file
add stats settings to sample config
let config override stats module (#133)
write some help for the stats module admin

Files:

• trunk/modules/extra/stats.tcl (modified) (3 diffs)

trunk/modules/extra/stats.tcl

@@ -26 +26 @@
 ## /JMS
 
-### CONFIG
+### CONFIG: now set in settings.tcl; this bit just sets the defaults
+### Don't change these any more, edit your settings file :)
 
 ## enable sending of stats etc
-set bMotion_stats_enabled 0
+if {![info exists bMotion_stats_enabled]} {
+        set bMotion_stats_enabled 0
+}
 
 ## enable version checking (doesn't need stats to be sent)
-set bMotion_stats_version 0
+if {![info exists bMotion_stats_version]} {
+        set bMotion_stats_version 0
+}
 
 
 ## what can we send (if stats_enabled is 1)
 # this is the bot's nick
-set bMotion_stats_send(botnick) 1
-# the admin info ('admin' in config)
-set bMotion_stats_send(admin) 1
-# the network name ('network' in config)
-set bMotion_stats_send(network) 1
-# bmotion's gender/orientation
-set bMotion_stats_send(bminfo) 1
+if {![info exists bMotion_stats_send]} {
+        set bMotion_stats_send(botnick) 1
+        # the admin info ('admin' in config)
+        set bMotion_stats_send(admin) 1
+        # the network name ('network' in config)
+        set bMotion_stats_send(network) 1
+        # bmotion's gender/orientation
+        set bMotion_stats_send(bminfo) 1
+}
 
 ### END USER CONFIG
@@ -341 +348 @@
 
                 if {$bMotion_stats_time > 0} {
-                        bMotion_putadmin "  last stats run was [expr [clock seconds] - $bMotion_stats_time] seconds ago"
+                        bMotion_putadmin "  last stats run was [expr [clock seconds] - $bMotion_stats_time] seconds ago ([clock format $bMotion_stats_time])"
                 } else {
                         bMotion_putadmin "  last stats run never or unknown"
@@ -364 +371 @@
         }
 }
+
+proc bMotion_stats_help { } {
+        bMotion_putadmin "Interact with the stats module."
+        bMotion_putadmin "  .bmotion stats status"
+        bMotion_putadmin "    Show the status of the stats module, including if it's enabled,"
+        bMotion_putadmin "    if it's checking for updates, your bots unique ID, when the last"
+        bMotion_putadmin "    stats run took place, and when the next one will."
+        bMotion_putadmin "  .bmotion stats go"
+        bMotion_putadmin "    Immediately perform a stats run (if needed)"
+        bMotion_putadmin "(See settings.tcl and modules/extra/stats.tcl for config and information."
+}
+
 if {$bMotion_testing == 0} {
-        bMotion_plugin_add_management "stats" "^stats" n bMotion_stats_admin "any"
+        bMotion_plugin_add_management "stats" "^stats" n bMotion_stats_admin "any" "bMotion_stats_help"
 }