Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
thakyuu committed Oct 6, 2019
1 parent ff3fad8 commit b82efed
Showing 1 changed file with 6 additions and 10 deletions.
16 changes: 6 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,12 @@

* OSCで受け取ったパスに存在する画像ファイルに対して、configのoverlayに指定した画像をオーバーレイ処理します

## 使い方
* `node.js`を導入して、本プロジェクトをDL、`npm install`を実行し、`node vrc-frameoverlay.js`で実行する
* ex.
```
git clone https://github.com/thakyuu/vrc-frameoverlay.git
cd vrc-frameoverlay
npm install
node vrc-frameoverlay.js
```
* config.jsonで待受ポートは変更出来ます。
## 使い方()
* vrc-frameoverlay.exeを実行して、オーバーレイ処理を行うツールを立ち上げます。
* VaNiiMenuなどのOSCで画像ファイルのパスを投げられるツールから、本ツールに対してOSCでパスを投げると処理を実行します。
* ex. VaNiiMenuの場合は、ImageViewerの左上のOSC Sendボタン
* 画像ファイルと同じディレクトリに、元ファイル名_overlay.pngという名称で、オーバーレイ処理を行った画像が保存されます。

* overlay.pngは1920x1080の透過pngを推奨します

## 注意事項
Expand Down

0 comments on commit b82efed

Please sign in to comment.