refactor: capital constants and lots of debug logging

Author: PassiveLemon

README.md

@@ -34,7 +34,7 @@ Features:
 - Clone the repo, cd to src
 - Run `nim c -r webfisher`
 - Edit the generated config file in your `~/.config/webfisher/config.json` (Linux), or `~\Appdata\Roaming\webfisher\config.json` (Windows).
-- If you run Webfisher from the CLI, you can also supply a config file with `-f <path to config.json>`.
+- If you run Webfisher from the CLI, you can also supply a config file with `-f="<path to config.json>"`.
   - Arguments can be found by tacking `-h` or `--help`
 
 Upon start, Webfisher will wait 5 seconds before attempting to do anything, so use this time to get Webfishing and your cursor situated.

default.nix

@@ -5,7 +5,7 @@
 }:
 buildNimPackage (finalAttrs: {
   pname = "webfisher";
-  version = "1.3.1";
+  version = "1.3.2";
 
   src = ./.;
 

src/webfisher.nim

@@ -9,6 +9,7 @@ import
   webfisher / [
     config,
     input,
+    logging,
     screen,
     task
   ]
@@ -34,15 +35,16 @@ var globalState: GlobalState = GlobalState(
 
 
 block webfisher:
+  debug("Starting Webfisher...")
   initConfig()
   initDisplay()
   initDevice()
 
-  echo fmt"Started in {globalConfig.gameMode} mode."
+  notice(fmt"Started in {globalConfig.gameMode} mode.")
   if globalConfig.autoSoda:
-    echo "AutoSoda enabled."
+    info("AutoSoda enabled.")
   if globalConfig.autoShop:
-    echo fmt"AutoShop enabled, using bait {globalConfig.bait}."
+    info(fmt"AutoShop enabled, using bait {globalConfig.bait}.")
 
   # Add some wait time so the user can get situated
   sleep(5000)

src/webfisher/cli.nim

@@ -6,7 +6,8 @@ import
   ]
 
 import
-  constants
+  constants,
+  logging
 
 
 type
@@ -34,7 +35,7 @@ Options:
   quit(0)
 
 proc cliVersion(): void =
-  echo fmt"Webfisher {releaseVersion}"
+  notice(fmt"Webfisher {RELEASEVERSION}")
   quit(0)
 
 proc processCliArgs*(): CliArgs =
@@ -43,6 +44,7 @@ proc processCliArgs*(): CliArgs =
   cliArgs.timestamps = false
 
   for kind, key, val in getopt():
+    debug(fmt"Arg key {key} value {val}")
     case kind
       of cmdArgument:
         cliArgs.mode = key

src/webfisher/config.nim

@@ -219,13 +219,10 @@ proc initConfig*(): void =
 
   initLogger(cliArgs.loglevel, cliArgs.timestamps)
 
+  debug("Initializing configuration...")
   if cliArgs.file != "":
     configDir = cliArgs.file
 
   createConfig(configDir)
   updateConfig(configDir)
   globalConfig = parseConfig(configDir, cliArgs)
-
-proc getConfig*(): Config =
-  return globalConfig
-

src/webfisher/constants.nim

@@ -4,52 +4,52 @@ type
 
 
 const
-  releaseVersion* = "1.3.1"
+  RELEASEVERSION* = "1.3.2"
 
-  fishingReelPixels*: PixelList = @[
+  FISHINGREELPIXELS*: PixelList = @[
     (428, 785, 156, 145, 74),
     (388, 745, 156, 145, 74), 
     (428, 705, 156, 145, 74),
     (468, 745, 156, 145, 74)
   ]
-  catchMenuPixels*: PixelList = @[
+  CATCHMENUPIXELS*: PixelList = @[
     (320, 800, 90, 117, 90),
     (1500, 850, 255, 238, 213), 
     (1500, 950, 255, 238, 213), 
     (400, 950, 255, 238, 213)
   ]
-  emptyBaitPixels*: PixelList = @[
+  EMPTYBAITPIXELS*: PixelList = @[
     (1853, 1033, 16, 28, 49),
     (1845, 1025, 16, 28, 49),
     (1838, 1017, 16, 28, 49)
   ]
-  baitShopPixels*: PixelList = @[
+  BAITSHOPPIXELS*: PixelList = @[
     (192, 157, 90, 117, 90),
     (1161, 157, 90, 117, 90), 
     (1135, 900, 255, 238, 213), 
     (210, 900, 255, 238, 213)
   ]
-  baitSelectPixels*: PixelList = @[
+  BAITSELECTPIXELS*: PixelList = @[
     (400, 350, 255, 238, 213),
     (1515, 350, 90, 117, 90), 
     (1521, 741, 255, 238, 213), 
     (397, 741, 255, 238, 213)
   ]
 
   # We only use the worms as the start since we then just move the cursor by known a known pixel distance to hit the other baits
-  baitShopWorm*: CursorPos = (280, 370)
-  baitShopPixelDistance*: int = 107
-  baitSelectWorm*: CursorPos = (566, 495)
-  baitSelectPixelDistance*: int = 38
+  BAITSHOPWORM*: CursorPos = (280, 370)
+  BAITSHOPPIXELSHOPDISTANCE*: int = 107
+  BAITSELECTWORM*: CursorPos = (566, 495)
+  BAITSELECTPIXELDISTANCE*: int = 38
 
-  animationCatchFish*: int = 2000
-  animationCatchMenu*: int = 1250
-  animationEquipItem*: int = 1250
-  animationDrinkSoda*: int = 1750
+  ANIMATIONCATCHFISH*: int = 2000
+  ANIMATIONCATCHMENU*: int = 1250
+  ANIMATIONEQUIPITEM*: int = 1250
+  ANIMATIONDRINKSODA*: int = 1750
 
-  animationMenuDelay*: int = 250
-  animationMenuClose*: int = 500
+  ANIMATIONMENUDELAY*: int = 250
+  ANIMATIONMENUCLOSE*: int = 500
 
-  uinputTimeout*: int = 10
-  uinputTime*: int = 20
+  UINPUTTIMEOUT*: int = 10
+  UINPUTTIME*: int = 20
 

src/webfisher/linux/input.nim

@@ -49,18 +49,23 @@ proc createDevice(): ptr libevdev_uinput =
   return uinput
 
 proc initDevice*(): void =
+  debug("Creating Webfisher input device...")
   webfisherDevice = createDevice()
+  debug("Attaching to display...")
   webfisherDisplay = XOpenDisplay(nil)
 
 proc cleanupDevice*(): void =
+  debug("Removing Webfisher input device...")
   libevdev_uinput_destroy(webfisherDevice)
+  debug("Detaching from display...")
   discard XCloseDisplay(webfisherDisplay)
 
 proc manageKey(key: int, state: int): void =
+  debug(fmt"Setting key {key} to state {state}...")
   libevdev_uinput_write_event(webfisherDevice, EV_KEY, key, state)
-  sleep(uinputTimeout) # Buffer time so listeners can see events more consistently
+  sleep(UINPUTTIMEOUT) # Buffer time so listeners can see events more consistently
   libevdev_uinput_write_event(webfisherDevice, EV_SYN, SYN_REPORT, 0)
-  sleep(uinputTimeout)
+  sleep(UINPUTTIMEOUT)
 
 proc pressKey(key: int): void =
   manageKey(key, 1)
@@ -86,10 +91,11 @@ proc pressNum*(num: int, time: int): void =
   releaseKey(num + 1)
 
 proc manageMouse(state: int): void =
+  debug(fmt"Setting mouse to state {state}...")
   libevdev_uinput_write_event(webfisherDevice, EV_KEY, BTN_LEFT, state)
-  sleep(uinputTimeout)
+  sleep(UINPUTTIMEOUT)
   libevdev_uinput_write_event(webfisherDevice, EV_SYN, SYN_REPORT, 0)
-  sleep(uinputTimeout)
+  sleep(UINPUTTIMEOUT)
 
 proc pressMouse*(): void =
   manageMouse(1)
@@ -103,6 +109,7 @@ proc pressMouse*(time: int): void =
   releaseMouse()
 
 proc moveMouseAbs*(x, y: int): void =
+  debug(fmt"Moving mouse (abs) to x {x} y {y}...")
   var
     # Most of this is unused since we use the root display so source doesn't apply
     # wSrc, wDest: Window # Unused
@@ -118,9 +125,10 @@ proc moveMouseAbs*(x, y: int): void =
     destX, destY)
 
   discard XFlush(webfisherDisplay)
-  sleep(uinputTimeout)
+  sleep(UINPUTTIMEOUT)
 
 proc moveMouseRel*(x, y: int): void =
+  debug(fmt"Moving mouse (rel) to x {x} y {y}...")
   var
     # Most of this is unused since we use the root display so source doesn't apply
     # wSrc, wDest: Window # Unused
@@ -136,5 +144,5 @@ proc moveMouseRel*(x, y: int): void =
     destX, destY)
 
   discard XFlush(webfisherDisplay)
-  sleep(uinputTimeout)
+  sleep(UINPUTTIMEOUT)
 

src/webfisher/linux/screen.nim

@@ -1,11 +1,14 @@
 import
+  std/strformat,
   x11 / [
     x,
     xlib,
     xutil
   ]
 
-import ../constants
+import
+  ../constants,
+  ../logging
 
 from ../config import globalConfig
 
@@ -31,12 +34,15 @@ var webfisherDisplay: PDisplay
 #     f.write(image.data[i * 4 + 0])
 
 proc initDisplay*(): void =
+  debug("Attaching to display...")
   webfisherDisplay = XOpenDisplay(nil)
 
 proc cleanupDisplay*(): void =
+  debug("Detaching from display...")
   discard XCloseDisplay(webfisherDisplay)
 
 proc getScreenshot(): PXImage =
+  debug("Getting screenshot...")
   var screenshot = XGetImage(webfisherDisplay,
     RootWindow(webfisherDisplay, DefaultScreen(webfisherDisplay)),
     globalConfig.screenConfig[0].cint,
@@ -53,40 +59,48 @@ proc getPixelColor(screenshot: PXImage; x: int; y: int): Pixel =
   pixel.r = ((color shr 16) and 0xFF).int
   pixel.g = ((color shr 8) and 0xFF).int
   pixel.b = (color and 0xFF).int
+  debug(fmt"Pixel r {pixel.r} g {pixel.g} b {pixel.b}")
   return pixel
 
 proc checkPixels(screenshot: PXImage, pixelList: PixelList, count: int): bool =
   var valid = 0
   for checkPixel in pixelList:
     let pixel = getPixelColor(screenshot, checkPixel.x, checkPixel.y)
+    debug(fmt"checkPixel r {checkPixel.r} g {checkPixel.g} b {checkPixel.b}")
     if pixel.r == checkPixel.r and
         pixel.g == checkPixel.g and
         pixel.b == checkPixel.b:
       # We test if most of the pixels match since the reel could block the pixel
       valid += 1
+      debug(fmt"Pixel match, valid +1 {valid}")
   discard XDestroyImage(screenshot)
   if valid >= count:
     return true
   else:
     return false
 
 proc getFishingGame*(): bool =
+  debug("Checking for fishing game...")
   let screenshot = getScreenshot()
-  return checkPixels(screenshot, fishingReelPixels, 3)
+  return checkPixels(screenshot, FISHINGREELPIXELS, 3)
 
 proc getCatchMenu*(): bool =
+  debug("Checking for catch menu...")
   let screenshot = getScreenshot()
-  return checkPixels(screenshot, catchMenuPixels, 3)
+  return checkPixels(screenshot, CATCHMENUPIXELS, 3)
 
 proc getEmptyBait*(): bool =
+  debug("Checking for empty bait...")
   let screenshot = getScreenshot()
-  return checkPixels(screenshot, emptyBaitPixels, 2)
+  return checkPixels(screenshot, EMPTYBAITPIXELS, 2)
 
 proc getBaitShop*(): bool =
+  debug("Checking for bait shop...")
   let screenshot = getScreenshot()
-  return checkPixels(screenshot, baitShopPixels, 3)
+  return checkPixels(screenshot, BAITSHOPPIXELS, 3)
 
 proc getBaitSelect*(): bool =
+  debug("Checking for bait select...")
   let screenshot = getScreenshot()
-  return checkPixels(screenshot, baitSelectPixels, 3)
+  return checkPixels(screenshot, BAITSELECTPIXELS, 3)
 

src/webfisher/logging.nim

@@ -8,9 +8,28 @@ import
 var consoleLog = newConsoleLogger(fmtStr="[$levelname]: ")
 
 
+proc debug*(str: string): void =
+  consoleLog.log(lvlDebug, str)
+
+proc info*(str: string): void =
+  consoleLog.log(lvlInfo, str)
+
+proc notice*(str: string): void =
+  consoleLog.log(lvlNotice, str)
+
+proc warn*(str: string): void =
+  consoleLog.log(lvlWarn, str)
+
+proc error*(str: string): void =
+  consoleLog.log(lvlError, str)
+
+proc fatal*(str: string): void =
+  consoleLog.log(lvlFatal, str)
+
 proc initLogger*(lvl: string, ts: bool): void =
   if ts:
     consoleLog = newConsoleLogger(fmtStr="[$datetime][$levelname]: ")
+    debug("Logger timestamps enabled.")
 
   case lvl:
     of "d", "debug", "6":
@@ -29,24 +48,7 @@ proc initLogger*(lvl: string, ts: bool): void =
     of "none", "0":
       setLogFilter(lvlNone)
     else:
-      consoleLog.log(lvlFatal, fmt"{lvl} is not a valid value for log-level.")
+      fatal(fmt"{lvl} is not a valid value for log-level.")
       quit(1)
 
-proc debug*(str: string): void =
-  consoleLog.log(lvlDebug, str)
-
-proc info*(str: string): void =
-  consoleLog.log(lvlInfo, str)
-
-proc notice*(str: string): void =
-  consoleLog.log(lvlNotice, str)
-
-proc warn*(str: string): void =
-  consoleLog.log(lvlWarn, str)
-
-proc error*(str: string): void =
-  consoleLog.log(lvlError, str)
-
-proc fatal*(str: string): void =
-  consoleLog.log(lvlFatal, str)
-
+  debug(fmt"Logger initialized with {lvl}.")

src/webfisher/newconfig.nim

@@ -0,0 +1,15 @@
+type
+  #  config      type    cli description
+  # ("autoShop", "type", "desc")
+  ConfigOption* = seq[tuple[c, t, d: string]]
+
+
+const
+  configFile*: ConfigOption = @[
+    ("autoShop", "bool", "Whether to automatically purchase bait")
+  ]
+  # configCli should inherit configFile options so Webfisher can be configured from Cli
+  configCli*: ConfigOption = @[
+    ("version", "bool", "Show version and exit")
+  ]
+