Skip to content

Latest commit

 

History

History
75 lines (56 loc) · 2.13 KB

README_ja.md

File metadata and controls

75 lines (56 loc) · 2.13 KB

VRChat Activity Viewer

VRChat ログ情報の保存・表示機能を持つ node.js コマンドラインツールです。 ログファイルから主要なログ情報の取得と保存、閲覧機能と型定義を提供します。

Github Packages で公開されている @kamakiri/vrchat-activity-viewer は Deprecated です。 新しい vrchat-activity-viewer パッケージを npm(npmjs) から利用してください。

Usage

CLI

$ va --filter myFriendName --range 24h
2021-1-1 00:00:00 join myFriendName
2021-1-1 00:00:05 leave myFriendName
2021-1-2 00:00:00 join myFriendName
2021-1-2 00:00:05 leave myFriendName

TypeScript / JavaScript

import { findLatestVRChatLogFullPath, parseVRChatLog } from "vrchat-activity-viewer";
const filePath = findLatestVRChatLogFullPath();
const latestLog = parseVRChatLog(
    fs.readFileSync(path.resolve(filePath), "utf8"), false); // you can get ActivityLog[]

Install

$ npm install vrchat-activity-viewer

va コマンドとしてグローバルにインストールする場合は、

$ npm install -g vrchat-activity-viewer

Run

$ ./bin/run

または、グローバルにインストールした場合、

$ va

初回実行時、ホームディレクトリに ~/.vrchatActivityViewer/db.json を生成します。

Options

  • -f --filter <words...>: 指定された字句で検索結果をフィルタします。複数指定すると OR マッチングします
  • -cf --case-filter: フィルタ時に単語の大文字小文字を区別します
  • -V --verbose: 詳細情報を表示します
  • -r --range <year/month/week/day/hour>: 検索範囲を指定します(ex: 1y, 2m, 3w, 4d, 5h)
  • -w --watch <sec>: 一定間隔で繰り返し実行します
  • -v --version: アプリケーションのバージョン情報を表示します
  • -h --help: ヘルプを表示します

Note

VRChat ログファイルの仕様は公に定められていません。 そのため、本モジュールの実行結果は、予期せぬタイミングで変わる・動作しなくなる可能性があります。