add linux support

Author: LunyaaDev

example/package.json

@@ -10,6 +10,7 @@
   "devDependencies": {
     "@types/node": "^22.13.1",
     "nodemon": "^3.1.9",
+    "ts-node": "^10.9.2",
     "typescript": "^5.7.3"
   },
   "dependencies": {

example/pnpm-lock.yaml

@@ -1,3 +1,4 @@
+import { homedir } from 'os'
 import { VrchatLogWatcher } from 'vrchat-log-watcher'
 
 const log = new VrchatLogWatcher()

example/src/index.ts

@@ -1,6 +1,6 @@
 {
   "name": "vrchat-log-watcher",
-  "version": "0.2.1",
+  "version": "0.3.0",
   "description": "Tool to watch and parse VRChat log files in realtime",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

package.json

@@ -11,6 +11,8 @@ import {
   Instance as VrchatInstance,
   parseLocation,
 } from 'vrchat-location-parser'
+import { getVrchatLogDir } from './utils/getVrchatLogDir'
+import { getLatestLogfile, isVrchatLogFile } from './utils/getLatestLogfile'
 
 export * from './interfaces/VrchatLogWatcherEventData'
 
@@ -79,16 +81,9 @@ export class VrchatLogWatcher extends EventEmitter {
 
   constructor() {
     super()
-    this.vrchatLogDir = path.join(
-      os.homedir(),
-      'Appdata',
-      'LocalLow',
-      'VRChat',
-      'VRChat',
-    )
-
+    this.vrchatLogDir = getVrchatLogDir()
     // start logging on init
-    this.currentLogFile = this.getLatestLogfile()
+    this.currentLogFile = getLatestLogfile(this.vrchatLogDir)
     this.watchFile()
 
     // watch new files in the loggin folder
@@ -98,10 +93,10 @@ export class VrchatLogWatcher extends EventEmitter {
         return
       }
       // is vrchat logfile
-      if (!this.isVrchatLogFile(filename)) {
+      if (!isVrchatLogFile(filename)) {
         return
       }
-      const newLogFile = this.getLatestLogfile()
+      const newLogFile = getLatestLogfile(this.vrchatLogDir)
       // is same logfile that current
       if (newLogFile === this.currentLogFile) {
         return
@@ -111,34 +106,6 @@ export class VrchatLogWatcher extends EventEmitter {
     })
   }
 
-  /**
-   * check whether the filename could be a vrchat file
-   * @param filename filename of a file
-   * @returns whether the file could be a vrchat log file.
-   */
-  private isVrchatLogFile = (filename: string) =>
-    filename.startsWith('output_log_')
-
-  /**
-   * get the latest log file path from vrchat folder
-   * @returns the latest logfile path if found
-   */
-  private getLatestLogfile = () => {
-    const logFiles = fs
-      .readdirSync(this.vrchatLogDir)
-      .filter((x) => this.isVrchatLogFile(x))
-      .map((x) => ({
-        filename: x,
-        createdAt: fs.statSync(path.join(this.vrchatLogDir, x)).ctime.getTime(),
-      }))
-      .sort((a, b) => b.createdAt - a.createdAt)
-
-    if (logFiles.length === 0) {
-      return null
-    }
-    return path.join(this.vrchatLogDir, logFiles[0].filename)
-  }
-
   /**
    * Watches the current file
    */
@@ -160,6 +127,9 @@ export class VrchatLogWatcher extends EventEmitter {
       this.emit('raw', data)
       this.parseLine(data)
     })
+    this.tail.on('error', (error) => {
+      this.tail?.unwatch()
+    })
   }
 
   /**

src/index.ts

@@ -0,0 +1,31 @@
+import * as fs from 'fs'
+import * as path from 'path'
+
+/**
+ * check whether the filename could be a vrchat file
+ * @param filename filename of a file
+ * @returns whether the file could be a vrchat log file.
+ */
+export const isVrchatLogFile = (filename: string) =>
+  filename.startsWith('output_log_')
+
+/**
+ * get the latest log file path from vrchat folder
+ * @param logDir dir with vrchat log files
+ * @returns the latest logfile path if found
+ */
+export const getLatestLogfile = (logDir: string) => {
+  const logFiles = fs
+    .readdirSync(logDir)
+    .filter((x) => isVrchatLogFile(x))
+    .map((x) => ({
+      filename: x,
+      createdAt: fs.statSync(path.join(logDir, x)).ctime.getTime(),
+    }))
+    .sort((a, b) => b.createdAt - a.createdAt)
+
+  if (logFiles.length === 0) {
+    return null
+  }
+  return path.join(logDir, logFiles[0].filename)
+}

src/utils/getLatestLogfile.ts

@@ -0,0 +1,24 @@
+import * as path from 'path'
+import * as os from 'os'
+
+export const getVrchatLogDir = () => {
+  // windows
+  if (process.platform == 'win32')
+    return path.join(os.homedir(), 'Appdata', 'LocalLow', 'VRChat', 'VRChat')
+  return path.join(
+    os.homedir(),
+    '.steam',
+    'steam',
+    'steamapps',
+    'compatdata',
+    '438100',
+    'pfx',
+    'drive_c',
+    'users',
+    'steamuser',
+    'AppData',
+    'LocalLow',
+    'VRChat',
+    'VRChat',
+  )
+}