Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kamakiri01/vrchat-activity-viewer
VRChat log file viewer
https://github.com/kamakiri01/vrchat-activity-viewer
Last synced: 22 days ago
JSON representation
VRChat log file viewer
- Host: GitHub
- URL: https://github.com/kamakiri01/vrchat-activity-viewer
- Owner: kamakiri01
- License: mit
- Created: 2021-01-09T14:45:39.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2024-02-14T20:00:36.000Z (11 months ago)
- Last Synced: 2024-05-01T12:55:55.326Z (8 months ago)
- Language: TypeScript
- Homepage:
- Size: 184 KB
- Stars: 1
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
[JP README](./README_ja.md)
# VRChat Activity Viewer
This is a node.js command line tool with the ability to save and view VRChat log information.
It provides functions for retrieving, saving, and viewing key log information from log files, as well as type definitions.
Old Github Packages `@kamakiri01/vrchat-activity-viewer` is **Deprecated**.
Use `vrchat-activity-viewer` from 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
```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
```
To install globally as a `va` command,
```
$ npm install -g vrchat-activity-viewer
```
## Run
```
$ ./bin/run
```
When installed globally,
```
$ va
```
The first time you run it, it will generate `~/.vrchatActivityViewer/db.json` in your home directory.
### Options
* `-f --filter `:
filter result with ignore case words. when specify space separeted words, use "or" matching
* `-cf --case-filter`:
use case sensitive filter
* `-ia --instance-all`
include same instance user names, world enter log
* `-ie --instance-enter`
include world enter log
* `-i, --import-dir `
specify log directory (default: VRChat App path)
* `-V --verbose`:
display full result details
* `-r --range `:
specify show range to display (default: "24h")(ex: 1y, 2m, 3w, 4d, 5h)
* `-w --watch `:
update db repeatedly
* `-v --version`:
output the current version
* `-h --help`:
display help for command
## Note
The specifications of the VRChat log file have not been publicly defined.
Therefore, the execution results of this module may change or stop working at unexpected times.