Skip to content

Commit

Permalink
update docs & bump version
Browse files Browse the repository at this point in the history
  • Loading branch information
usagi committed Oct 7, 2023
1 parent 4f592a8 commit 219b167
Show file tree
Hide file tree
Showing 3 changed files with 34 additions and 3 deletions.
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "virtual-avatar-connect"
version = "0.0.0-alpha.0"
version = "0.1.0"
edition = "2021"

[lib]
Expand Down
27 changes: 27 additions & 0 deletions conf.example-ss-ocr.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# ← これを書いた行は「コメント」になります。設定ファイルの中にメモを書き残したいときに使うと便利です。
# スクリーンショット(ウィンドウのスクショを撮影→ファイルに保存してファイルパスを送信)

# ↓ これを書くと「ここから特定のプロセッサーの設定をはじめるよ」という意味になります。
[[processors]]
# 「今回は "screenshot" タイプのプロセッサーを使うよ」という意味になります。
feature = "screenshot"
# 着信を受け取るチャンネル名
channel_from = "ss"
# 結果を出力するチャンネル名
channel_to = "ocr"
# スクショを撮影したいウィンドウのタイトルに含まれる文字列を記入します
# とりあえずシンプルな「メモ帳」などで試してみましょう。
# この設定項目では . ? * ( ) \ $ ^ などの文字は特別な用途(正規表現)で使われるので、よくわからなければ今はそうした文字が入らない設定を試してみましょう。
title_regex = "ここにキャプチャーしたいウィンドウのタイトルに含まれる文字列を記入します"
# スクショの保存先を指定します。
paths = [ "ss.png" ]

# OCR(画像認識→テキスト)
[[processors]]
channel_from = "ocr"
channel_to = "description"
feature = "ocr"
# 日本語の文字を読み取りたい場合は "ja_JP" 、USA英語なら "en_US" のように設定します。
lang = "ja_JP"
# 入力として Screenshot などチャンネルの前段階のプロセッサーが出力した内容を受け取りたい場合は true にします。
load_from_content = true
8 changes: 6 additions & 2 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -359,8 +359,12 @@ <h1>
<div class="flow">
<h2>手順</h2>
<ul>
<li>5-1. 設定ファイル "conf.toml" を編集し、《Screenshot》プロセッサーと《OCR》プロセッサーを設定します。
<p>とりあえずコピペで設定ファイルの一番下に追加してみましょう。👀†1</p>
<li>5-1. 《Screenshot》と《OCR》のシンプルな設定例の設定ファイル "conf.example-ss-ocr.toml" を "virtual-avatar-connect.exe" へドロップして VAC
を起動してみましょう。
<p class="info">
コマンドラインでは `./virtual-avatar-connect conf.example-ss-ocr.toml` です。コマンドラインでの使い方は `--help` で確認できます。
</p>
<p>この設定ファイル "conf.example-ss-ocr.toml" の中身はこうなっています。👀</p>
<textarea class="code" readonly style="height:44em">
# ← これを書いた行は「コメント」になります。設定ファイルの中にメモを書き残したいときに使うと便利です。
# スクリーンショット(ウィンドウのスクショを撮影→ファイルに保存してファイルパスを送信)
Expand Down

0 comments on commit 219b167

Please sign in to comment.