https://github.com/kamakiri01/vrchat-join-notifier

Notify when user joined
https://github.com/kamakiri01/vrchat-join-notifier

Last synced: about 1 month ago
JSON representation

Notify when user joined

• Host: GitHub
• URL: https://github.com/kamakiri01/vrchat-join-notifier
• Owner: kamakiri01
• License: mit
• Created: 2021-05-01T12:47:25.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2024-06-15T12:30:21.000Z (6 months ago)
• Last Synced: 2024-10-15T12:07:10.686Z (2 months ago)
• Language: TypeScript
• Homepage:
• Size: 25.7 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• 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 Join Notifier

This is a Node.js command line tool that notifies you of the names of users who have joined/leaved to the same instance of VRChat while it is running.

A standalone executable for windows has been released.

## Usage

```

$ ./bin/run -t join

```

### Install

```

$ git clone [email protected]:kamakiri01/vrchat-join-notifier.git

$ cd vrchat-join-notifier

$ npm install

$ npm run build

```

To install globally as a `vn` command,

```

$ npm install -g

```

### Run

```

$ ./bin/run

```

When installed globally,

```

$ vn

```

Or, run `$ npm run deploy` and `vrchat-join-notifier/vrchat-join-notifier.exe`.

### Options

* `-s --specific-names `:

  specific notification names(with another notification sound)

* `-se, --specific-exec `:

  exec command when match specific names. Replace %{{names}} in command text with join user names. ex: -s mySpecialFriendName -se "echo %{{names}}"

* `-i, --interval `

  specify check interval (default: "2")

* `-nt, --no-toast`

  prevent toast notification

* `-nx, --no-xsoverlay`

  prevent xsoverlay notification

and other options. see `-h` option.

### Giving coffee

You can give coffee fee.

[VRChatJoinNotifier - Iwanuki S.P.A. - BOOTH](https://iwanuki.booth.pm/items/2947584)