Move app settings into config files
This commit is contained in:
@@ -34,65 +34,83 @@ names = [
|
||||
]
|
||||
|
||||
[guest]
|
||||
names = [
|
||||
"GuestUserA",
|
||||
"GuestUserB"
|
||||
]
|
||||
file = "config/guests.txt"
|
||||
|
||||
[notice]
|
||||
missing_count = 3
|
||||
|
||||
[ocr.crop]
|
||||
left = 0.05
|
||||
top = 0.35
|
||||
right = 0.95
|
||||
bottom = 0.95
|
||||
|
||||
[ocr]
|
||||
preprocess = true
|
||||
scale = 1.5
|
||||
use_angle_cls = false
|
||||
```
|
||||
|
||||
`self.name` は Discord 自動ミュート判定に使う。
|
||||
|
||||
`staff.names` は表示対象だが guest 人数には含めない。
|
||||
|
||||
`guest.names` は guest 人数の母数と在室判定に使う。
|
||||
`guest.file` は guest 名簿ファイル。guest 人数の母数と在室判定に使う。
|
||||
|
||||
`notice.missing_count` は「あと何人以内で全員集合か」の通知範囲。例えば guest が 23 人で `missing_count = 3` の場合、20〜22 人のときに未入室 guest を出す。
|
||||
|
||||
## 秘密情報
|
||||
|
||||
`.env` に置く。このファイルは Git に入れない。
|
||||
|
||||
雛形は `.env.example`。
|
||||
|
||||
```env
|
||||
DISCORD_WEBHOOK_URL=
|
||||
VRCHAT_USERNAME=
|
||||
VRCHAT_PASSWORD=
|
||||
|
||||
OCR_CROP_LEFT=0.05
|
||||
OCR_CROP_TOP=0.35
|
||||
OCR_CROP_RIGHT=0.95
|
||||
OCR_CROP_BOTTOM=0.95
|
||||
OCR_PREPROCESS=1
|
||||
OCR_SCALE=1.5
|
||||
OCR_USE_ANGLE_CLS=0
|
||||
```
|
||||
|
||||
`DISCORD_WEBHOOK_URL` は VRC ログ結果の Discord Webhook 通知に使う。
|
||||
|
||||
`VRCHAT_USERNAME` / `VRCHAT_PASSWORD` は `src/getUser.py` を使う場合だけ必要。
|
||||
|
||||
OCR 設定は速度と精度の調整用。
|
||||
|
||||
`OCR_CROP_*` は VRChat ウィンドウ内の相対座標。`0.0` から `1.0` で指定する。デフォルトは画面下側の中央寄りだけを読む。
|
||||
`ocr.crop` は VRChat ウィンドウ内の相対座標。`0.0` から `1.0` で指定する。デフォルトは画面下側の中央寄りだけを読む。
|
||||
|
||||
フル画面 OCR に戻す場合。
|
||||
|
||||
```env
|
||||
OCR_CROP_LEFT=0
|
||||
OCR_CROP_TOP=0
|
||||
OCR_CROP_RIGHT=1
|
||||
OCR_CROP_BOTTOM=1
|
||||
```toml
|
||||
[ocr.crop]
|
||||
left = 0
|
||||
top = 0
|
||||
right = 1
|
||||
bottom = 1
|
||||
```
|
||||
|
||||
`OCR_PREPROCESS=1` はグレースケール化、コントラスト補正、シャープ化、拡大を行う。
|
||||
`ocr.preprocess = true` はグレースケール化、コントラスト補正、シャープ化、拡大を行う。
|
||||
|
||||
`OCR_SCALE` は前処理時の拡大率。大きいほど小さい文字に強くなるが遅くなる。
|
||||
`ocr.scale` は前処理時の拡大率。大きいほど小さい文字に強くなるが遅くなる。
|
||||
|
||||
`OCR_USE_ANGLE_CLS=0` は角度分類を切って高速化する。縦書きや回転文字を読む必要がある場合だけ `1` にする。
|
||||
`ocr.use_angle_cls = false` は角度分類を切って高速化する。縦書きや回転文字を読む必要がある場合だけ `true` にする。
|
||||
|
||||
## guest 名簿
|
||||
|
||||
`config/guests.txt` に 1 行 1 名で書く。このファイルは Git に入れない。
|
||||
|
||||
雛形は `config/guests.example.txt`。
|
||||
|
||||
```text
|
||||
GuestUserA
|
||||
GuestUserB
|
||||
GuestUserC
|
||||
```
|
||||
|
||||
空行と `#` で始まる行は無視する。
|
||||
|
||||
## 秘密情報
|
||||
|
||||
秘密情報は `config/secrets.toml` に置く。このファイルは Git に入れない。
|
||||
|
||||
雛形は `config/secrets.example.toml`。
|
||||
|
||||
```toml
|
||||
[discord]
|
||||
webhook_url = ""
|
||||
|
||||
[vrchat]
|
||||
username = ""
|
||||
password = ""
|
||||
```
|
||||
|
||||
`discord.webhook_url` は VRC ログ結果の Discord Webhook 通知に使う。
|
||||
|
||||
`vrchat.username` / `vrchat.password` は `src/getUser.py` を使う場合だけ必要。
|
||||
|
||||
## OSC パラメータ
|
||||
|
||||
@@ -188,6 +206,8 @@ OCR text、翻訳 text、VRC ログ結果は `runtime/runtime.log` に追記す
|
||||
|
||||
- `.env`
|
||||
- `config/config.toml`
|
||||
- `config/secrets.toml`
|
||||
- `config/guests.txt`
|
||||
- `runtime/`
|
||||
- `__pycache__/`
|
||||
- `*.pyc`
|
||||
|
||||
Reference in New Issue
Block a user