Files
VRCWT-OSC/README.md
2026-06-25 00:09:58 +09:00

74 lines
1.8 KiB
Markdown

# VRC_OSC
VRChat のログ監視、Discord ミュート連携、OCR、同意リスト生成をまとめたツールです。
## 主な機能
- VRChat の入退出ログを監視して `join / leave` を出力
- Discord のミュート切り替え
- OCR で画面文字を取得
- 同意フォーム用の JSON 生成とログ抽出
- Gitea Release からの自動更新
## 起動方法
配布 zip を展開したら、まず `vrc_osc_launcher.exe` を起動してください。
```powershell
vrc_osc_launcher.exe
```
launcher は起動時に最新 Release を確認します。新しい版があれば自動で更新してから本体を起動します。
本体を直接起動することもできます。
```powershell
vrc_osc.exe
```
ただし、この場合は自動更新は走りません。
## 配布物
Release の zip には次のファイルが入ります。
- `vrc_osc.exe`
- `vrc_osc_launcher.exe`
- `vrwt_tool.exe`
- `config.example.toml`
- `secrets.example.toml`
- `guests.example.txt`
## 設定
設定ファイルは exe の横の `config/` に置きます。
- `config/config.toml`
- `config/secrets.toml`
- `config/guests.txt`
最初は各 `*.example.*` をコピーして使ってください。
## Release 更新
自動更新は Gitea の Release を参照します。
- 更新元: `https://git.vrcworldtour.com/every_holiday/VRCWT-OSC/releases`
- 対象 asset: `vrc_osc-windows.zip`
## 開発時のビルド
```powershell
go test ./...
go build -ldflags="-H windowsgui" -o .\dist\vrc_osc.exe ./cmd/vrc_osc
go build -ldflags="-H windowsgui" -o .\dist\vrc_osc_launcher.exe ./cmd/vrc_osc_launcher
go build -o .\dist\vrwt_tool.exe ./cmd\vrwt_tool
```
## ログ
- `runtime/runtime.log`
- `runtime/join_leave.log`
- `runtime/latest_ocr.png`
- `runtime/latest_screenshot.png`