config options, user defined colors

Author: smt923

.gitignore

@@ -4,6 +4,7 @@
 ## Custom
 *.zip
 *log.txt
+builds/
 
 ### Nim ###
 nimcache/

settings.toml

@@ -0,0 +1,34 @@
+# Channels format should be like this: ["channel", "channel2", "channel3"] or
+# just ["channel"] for a single entry
+#
+# Set use_config_channels to true to use the channels from the config, or false to
+# ask you for channels every time
+#
+# Highlights are added in the same format as channels, it colors a message in red
+# if it contains one of your highlight phrases (a good example is your username)
+# you can have [""] for none
+#
+# Logging enables logging the chat to a text file (true for on, false for off)
+#
+# log_save_lines is the number of lines before the log file is saved
+
+[general]
+channels = ["change_me"]
+use_config_channels = false
+highlights = [""]
+logging = false
+log_save_lines = 10
+
+# Available text colors are:
+# white black red green yellow blue magenta cyan
+#
+# Highlight and sub colors are for the message background
+
+[colors]
+chat = "white"
+highlight = "red"
+error = "red"
+join = "green"
+part = "red"
+modstatus = "cyan"
+subnotice = "magenta"

tinytwitch.nim

@@ -1,13 +1,29 @@
 import irc, times, terminal, random, strutils, strtabs, os
+import parsetoml
 from rawsockets import Port
 
+var cfg: File
+if not cfg.open("settings.toml"):
+  echo "ERROR: settings.toml file not found!"
+  discard readChar(stdin)
+  quit 1
+
+type
+  ChatColors = object
+    chat, error, join, part, mods: ForegroundColor
+    highlight, subs: BackgroundColor
+
 const
   CHAT_URL = "irc.chat.twitch.tv"
   CHAT_PORT = Port(6667)
 
+let
+  config = parsetoml.parseFile("settings.toml")
+
 var
   shouldLog = false
   linecounter = 0
+
 # check if a string contains some text that can be found in a set
 # there's probably a cleaner/smarter way to do this, will update at some point
 proc hasTextInSet(str: string, s: seq): bool =
@@ -21,6 +37,30 @@ proc hasTextInSet(str: string, s: seq): bool =
       continue
   return bHighlight
 
+proc getFgColor(str: string): ForegroundColor =
+  case str:
+    of "white": return fgWhite
+    of "black": return fgBlack
+    of "red": return fgRed
+    of "green": return fgGreen
+    of "yellow": return fgYellow
+    of "blue": return fgBlue
+    of "magenta": return fgMagenta
+    of "cyan": return fgCyan
+    else: discard
+
+proc getBgColor(str: string): BackgroundColor =
+  case str:
+    of "white": return bgWhite
+    of "black": return bgBlack
+    of "red": return bgRed
+    of "green": return bgGreen
+    of "yellow": return bgYellow
+    of "blue": return bgBlue
+    of "magenta": return bgMagenta
+    of "cyan": return bgCyan
+    else: discard
+
 # add a hash to the channel name if there isn't one there already
 proc addHash(s: string): string =
   if s.startsWith('#'):
@@ -51,46 +91,56 @@ proc logToFile(f: File, s: string) =
   if shouldLog:
     f.writeLine(s)
     linecounter += 1
-    if linecounter >= 10:
+    if linecounter >= config.getInt("log_save_lines"):
       f.flushFile()
       linecounter = 0
 
-var chans = newSeq[string](0)
-var highlights = newSeq[string](0)
-if paramCount() == 0:
+let chatColor: ref ChatColors = new(ChatColors)
+
+chatColor.chat = getFgColor(config.getString("colors.chat"))
+chatColor.error = getFgColor(config.getString("colors.error"))
+chatColor.join = getFgColor(config.getString("colors.join"))
+chatColor.part = getFgColor(config.getString("colors.part"))
+chatColor.mods = getFgColor(config.getString("colors.modstatus"))
+
+chatColor.highlight = getBgColor(config.getString("colors.highlight"))
+chatColor.subs = getBgColor(config.getString("colors.subnotice"))
+
+var 
+  chans = newSeq[string](0)
+  highlights = newSeq[string](0)
+
+if config.getBool("general.use_config_channels") == false:
   echo("Type the usernames of the channels to join, seperated by spaces: ")
   var channelin: string = readLine(stdin)
   for chan in splitWhitespace(channelin): 
     chans.add(addHash(chan.toLowerAscii()))
+else:
+  for chan in config.getStringArray("general.channels"):
+    chans.add(addHash(chan.toLowerAscii()))
 
-elif paramCount() >= 1:
-  for param in commandLineParams():
-    chans.add(addHash(param.toLowerAscii()))
-
-echo("Type the words you wish to highlight, seperated by spaces (or just press enter for none): ")
-var highlightin: string = readLine(stdin)
-if not highlightin.isNilOrWhitespace(): 
-  for hl in splitWhitespace(highlightin):
-    highlights.add(hl)
+for highlight in config.getStringArray("general.highlights"):
+    if not highlight.isNilOrWhitespace():
+      highlights.add(highlight)
 
-echo("Do you want to log the chat to a file? (y = yes, just press enter for no)")
-var loggingin: string = readLine(stdin)
-if loggingin.contains("y") or loggingin.contains("yes"):
+if config.getBool("general.logging") == true:
   shouldLog = true
+else:
+  shouldLog = false
 
 var username = randomTwitchUser()
 var t = irc.newIrc(CHAT_URL, CHAT_PORT , username, username,
                     joinChans = chans)
-var curtime: string
 
+var curtime: string
 t.connect()
 # this gives us things such as userlist, joins, parts and mod status:
 t.send("CAP REQ :twitch.tv/membership twitch.tv/commands twitch.tv/tags", false) 
 
 var chatline = ""
-var filename = getDateStr()&"_twitchchat_log.txt"
-var f: File 
+var f: File
 if shouldLog:
+  var filename = getDateStr()&"_twitchchat_log.txt"
   if f.open(filename):
     discard f.open(filename, fmAppend)
   else:
@@ -105,18 +155,18 @@ while true:
     case event.typ
     of EvConnected:
       chatline = "$1 - [INFO] Connected to server" % [curtime]
-      styledWriteLine(stdout, fgWhite, chatline)
+      styledWriteLine(stdout, chatColor.chat, chatline)
       f.logToFile(chatline)
 
     of EvDisconnected:
       chatline = "$1 - [ERR] Disconnected, reconnecting..." % [curtime]
-      styledWriteLine(stdout, fgRed, chatline)
+      styledWriteLine(stdout, chatColor.error, chatline)
       f.logToFile(chatline)
       t.reconnect()
 
     of EvTimeout:
       chatline = "$1 - [ERR] Timeout, reconnecting..." % [curtime]
-      styledWriteLine(stdout, fgRed, chatline)
+      styledWriteLine(stdout, chatColor.error, chatline)
       f.logToFile(chatline)
       t.reconnect()
 
@@ -127,64 +177,64 @@ while true:
           username = username.addTwitchBadges(event).strip()
           if event.user == "twitchnotify":
             chatline = "$1 $2 - [SUB] $3" % [curtime, event.origin, event.params[1]]
-            styledWriteLine(stdout, fgWhite, bgMagenta, styleBright, chatline)
+            styledWriteLine(stdout, chatColor.chat, chatColor.subs, styleBright, chatline)
             f.logToFile(chatline)      
           elif event.params[1].hasTextInSet(highlights):
             chatline = "$1 $2 - [MSG] $3: $4" % [curtime, event.origin, username, event.params[1]]
-            styledWriteLine(stdout, fgWhite, bgRed, styleBright, chatline)
+            styledWriteLine(stdout, chatColor.chat, chatColor.highlight, styleBright, chatline)
             f.logToFile(chatline)              
           else:
             chatline = "$1 $2 - [MSG] $3: $4" % [curtime, event.origin, username, event.params[1]]
-            styledWriteLine(stdout, fgWhite, chatline)
+            styledWriteLine(stdout, chatColor.chat, chatline)
             f.logToFile(chatline)
 
         of MJoin:
           chatline = "$1 $2 - [JOIN] $3" % [curtime, event.origin, event.nick]
-          styledWriteLine(stdout, fgGreen, chatline)
+          styledWriteLine(stdout, chatColor.join, chatline)
           f.logToFile(chatline)
 
         of MPart:
           chatline = "$1 $2 - [PART] $3" % [curtime, event.origin, event.nick]
-          styledWriteLine(stdout, fgRed, chatline)
+          styledWriteLine(stdout, chatColor.part, chatline)
           f.logToFile(chatline)
 
         of MMode:
           if event.params[1] == "+o":
             chatline = "$1 $2 - [+MOD] $3" % [curtime, event.origin, event.params[2]]
-            styledWriteLine(stdout, fgCyan, chatline)
+            styledWriteLine(stdout, chatColor.mods, chatline)
             f.logToFile(chatline)
           elif event.params[1] == "-o":
             chatline = "$1 $2 - [-MOD] $3" % [curtime, event.origin, event.params[2]]
-            styledWriteLine(stdout, fgCyan, chatline)
+            styledWriteLine(stdout, chatColor.mods, chatline)
             f.logToFile(chatline)
 
         of MUnknown:
           if event.raw.contains(" CLEARCHAT "):
             chatline = "$1 $2 - [INFO] $3 was timed out for $4 seconds" % [curtime, event.origin, event.params[1], event.tags["ban-duration"]]
-            styledWriteLine(stdout, fgWhite, chatline)
+            styledWriteLine(stdout, chatColor.chat, chatline)
             f.logToFile(chatline)
           elif event.raw.contains(" USERNOTICE "):
             var submsgs = event.tags["system-msg"]
             var submsg  = ""
             if submsgs.contains(".") and event.params.len() <= 1:
               submsg = submsgs.split(".")[1].replace(r"\s", " ").strip()
               chatline = "$1 $2 - [SUB] $3" % [curtime, event.origin, submsg]
-              styledWriteLine(stdout, fgWhite, bgMagenta, styleBright, chatline)
+              styledWriteLine(stdout, chatColor.chat, chatColor.subs, styleBright, chatline)
               f.logToFile(chatline)
             elif submsgs.contains(".") and event.params.len() >= 2:
               submsg = submsgs.split(".")[1].replace(r"\s", " ").strip()
               chatline = "$1 $2 - [SUB] $3 - $4" % [curtime, event.origin, submsg, event.params[1]]
-              styledWriteLine(stdout, fgWhite, bgMagenta, styleBright, chatline)
+              styledWriteLine(stdout, chatColor.chat, chatColor.subs, styleBright, chatline)
               f.logToFile(chatline)
             elif event.params.len() <= 1:
               submsg = submsgs.replace(r"\s", " ").strip()
               chatline = "$1 $2 - [SUB] $3" % [curtime, event.origin, submsg]
-              styledWriteLine(stdout, fgWhite, bgMagenta, styleBright, chatline)
+              styledWriteLine(stdout, chatColor.chat, chatColor.subs, styleBright, chatline)
               f.logToFile(chatline)
             else:
               submsg = submsgs.replace(r"\s", " ").strip()
               chatline = "$1 $2 - [SUB] $3 - $4" % [curtime, event.origin, submsg, event.params[1]]
-              styledWriteLine(stdout, fgWhite, bgMagenta, styleBright, chatline) 
+              styledWriteLine(stdout, chatColor.chat, chatColor.subs, styleBright, chatline) 
               f.logToFile(chatline)             
         else:
           discard