Merge pull request #115 from Cilda/maintenance-docs

ドキュメント整備
Cilda · Nov 29, 2023 · a194d09 · a194d09
2 parents 1304d6b + 383e23b
commit a194d09
Show file tree

Hide file tree

Showing 23 changed files with 133 additions and 110 deletions.
diff --git a/README.md b/README.md
@@ -11,20 +11,11 @@ Tesseract OCRを使用して画面のスクリーンショットからイベン
 
 ## 目次
 * [ウマウマチェッカー](#ウマウマチェッカー)
-  * [機能](#機能)
-    * [育成ウマ娘の選択](#育成ウマ娘の選択)
-    * [育成ウマ娘の自動選択](#育成ウマ娘の自動選択)
-    * [イベントの認識](#イベントの認識)
-    * [イベントを最新の状態へ更新](#イベントを最新の状態へ更新)
-      * [イベントデータについて](#イベントデータについて)
-    * [ウマ娘詳細の自動結合](#ウマ娘詳細の自動結合)
-    * [フォントとサイズを変更](#フォントとサイズを変更)
-    * [効果の表示行数](#効果の表示行数)
-    * [「選択肢なし」のイベントを表示しない](#「選択肢なし」のイベントを表示しない)
-    * [ステータスバーを表示する](#ステータスバーを表示する)
-    * [OCR設定](#OCR設定)
-      * [OCR数](#OCR数)
-      * [キャプチャ方法](#キャプチャ方法)
+  * [使い方](#使い方)
+    * [ウマ娘の自動選択](docs/umamusume-auto-choise.md)
+    * [イベントの認識](docs/recognize-event.md)
+    * [レシート因子撮影](docs/merge-umamusume-detail.md)
+    * [設定画面](docs/settings.md)
   * [インストール](#インストール)
   * [実行](#実行)
   * [サポート](#サポート)
@@ -34,102 +25,14 @@ Tesseract OCRを使用して画面のスクリーンショットからイベン
   * [免責事項](#免責事項)
   * [更新履歴](#更新履歴)
 
-## 機能
-ウマウマチェッカーは主に以下の機能を備えています。
- - 育成ウマ娘の自動選択
- - イベント選択肢からステータスを表示
-
-### 育成ウマ娘の選択
-育成ウマ娘のコンボボックスから育成対象のウマ娘を選択します。
-名前の一部を入力するとオートコンプリート機能により候補を表示することができます。
-
-### 育成ウマ娘の自動選択
-![自動選択](images/自動選択.png)  
-スタートした状態で育成前・育成中に育成ウマ娘詳細を表示すると認識されます。  
-ウマ娘詳細を表示すると自動で選択が行われるため、変更したくない場合はストップ状態にしてください。
-
-### イベントの認識
-スタートした状態で育成を行います。  
-イベントが表示されると自動で認識が行われ画面にステータスが表示されます。  
-サポートカードイベントは育成ウマ娘を選択しなくても認識されますが、育成ウマ娘イベントについては育成ウマ娘を選択しないと認識されません。  
-認識されないイベントがある場合は一度 [イベントを最新の状態へ更新](#イベントを最新の状態へ更新) をお試しください。  
-※ウマ娘のウィンドウサイズが極端に小さい場合は認識しない場合はあります。
-
-### イベントを最新の状態へ更新
-![イベント更新](images/更新.png)  
-「更新」ボタンを押すことでイベントに更新があれば最新に更新されます。  
-アップデートにより追加されたウマ娘・サポートカードのイベントが認識されない場合は
-更新することで認識されるようになります。  
-
-#### イベントデータについて  
-   ・イベントデータは [GameWith](https://gamewith.jp/uma-musume/)様のサイトよりデータを抽出し生成しています。   
-   ・イベントデータは毎日 __9時__、__15時__、__18時__、__22時__ に更新しています。  
-   　※サーバの状態によっては更新が遅れることがあります  
-   ・新しいカードが発表された当日はまだデータが揃ってない可能性があります。 
-
-### ウマ娘詳細の自動結合
-ウマ娘詳細のスキル・継承タブのスキル一覧を自動で結合して保存する機能です。  
-赤枠で囲っているボタンで結合することができます。  
-![キャプチャ開始](images/%E8%87%AA%E5%8B%95%E7%B5%90%E5%90%88%E9%96%8B%E5%A7%8B%E5%89%8D.png)  
-各ボタンの意味は以下の通りです。  
-|ボタンの種類|意味|  
-|:---:|:---|  
-|![赤丸](images/%E8%B5%A4%E4%B8%B8%E3%83%9C%E3%82%BF%E3%83%B3.png)|押すことでキャプチャを開始します。|
-|![緑四角](images/%E7%B7%91%E5%9B%9B%E8%A7%92%E3%83%9C%E3%82%BF%E3%83%B3.png)|スクロールバーを上部までしてください。上部に移動すると赤の四角にボタンが変わります。|
-|![赤四角](images/%E8%B5%A4%E5%9B%9B%E8%A7%92%E3%83%9C%E3%82%BF%E3%83%B3.png)|キャプチャ中です。途中で押すと、押された時点の画像を最後として結合します。|
-
-キャプチャ中はタイトルバーにfpsが表示されます。  
-高速でスクロールしすぎると正しくキャプチャされない可能性がありますのでご注意ください。  
-スクロールバーを最後までスクロールするとキャプチャが自動で終了します。  
-※キャプチャが自動で終了しない場合は、手動で![赤四角](images/%E8%B5%A4%E5%9B%9B%E8%A7%92%E3%83%9C%E3%82%BF%E3%83%B3.png)で終了してください。  
-　またウィンドウサイズを大きくすることで正しく認識される可能性があります。  
-　自動で終了されない等の場合がありましたら、output.logを添付してIssuesで起票を行ってください。  
-
-保存が完了すると、スクリーンショットフォルダに```combine_YYYY-MM-DD_hh-mm-ss```の形式で画像が保存されます。  
-現在はウマ娘詳細の```スキル```と```継承```タブのみをサポートしています。
-
-### フォントとサイズを変更
-デフォルトのフォントが見づらい等の場合に変更します。  
-4Kディスプレイを用いて育成する場合など、ウィンドウサイズが小さい時に変更することで表示が見やすくなります。  
-現在はフォントとフォントサイズの変更に対応しています。  
-デフォルトではYu Gothic UIが選択されています。
-
-### 効果の表示行数
-![表示行数](images/表示行数設定.png)  
-表示行数を変更することで以下のようにイベントの効果が表示されるテキストボックスの行数が調整できます。  
-(4行から6行に変更した場合)  
-![表示行数4行](images/%E8%A1%A8%E7%A4%BA%E8%A1%8C%E6%95%B04.png)
-![表示行数6行](images/%E8%A1%A8%E7%A4%BA%E8%A1%8C%E6%95%B06.png)  
-
-### 「選択肢なし」のイベントを表示しない
-選択肢がないイベントの場合、チェックを入れることでイベントが表示されなくなります。  
-選択肢のタイトルが「選択肢なし」と付くイベントが含まれる場合のみのため、一部のイベントは表示される可能性があります。
-
-### ステータスバーを表示する
-ステータスバーを表示します。  
-ステータスバーには1秒毎にアプリケーションのCPUとメモリの使用率が表示されます。
-
-### OCR設定
-OCRを行う際の設定です。
-
-#### OCR数
-起動時に予めOCR数の設定値分だけTesseractのインスタンスを生成します。  
-1インスタンスあたり20MB程度メモリを消費します。  
-生成されたインスタンスはすべて使われるわけではなく、  
-イベントを1度識別するごとに3～4つ程度のスレッドでインスタンスを使用します。  
-
-#### キャプチャ方法
-イベントの識別やスクリーンショット撮影時のキャプチャ方法を選択します。  
-- BitBlt   
-全ての環境で動作します。   
-ウマ娘のウィンドウに他のウィンドウが重なっている場合、  
-スクリーンショットに重なっているウィンドウが映り込みます。
-
-- Windows 10 (1903以降)  
-Windows Graphics Captureの機能を使いウマ娘のウィンドウを撮影します。  
-他のウィンドウがウマ娘のウィンドウに重なっていてもウマ娘のみをキャプチャできます。  
-Windows 10の1903以降で利用可能です。  
-利用できない場合は設定に選択肢が表示されません。
+
+## 使い方
+
+使い方は以下を参照してください。  
+- [ウマ娘の自動選択](docs/umamusume-auto-choise.md)  
+- [イベントの認識](docs/recognize-event.md)  
+- [レシート因子撮影](docs/merge-umamusume-detail.md)  
+- [設定画面](docs/settings.md)  
 
 ## インストール
 [リリースページ](https://github.com/Cilda/UmaUmaChecker/releases)から最新バージョンのUmaUmaChecker_vX.X.X_x64.zipをダウンロードします。  

diff --git a/docs/images/merge_button.png b/docs/images/merge_button.png
diff --git a/docs/images/settingdialog.png b/docs/images/settingdialog.png
diff --git a/docs/images/start.png b/docs/images/start.png
diff --git a/docs/images/top.png b/docs/images/top.png
diff --git a/docs/images/update_notice.png b/docs/images/update_notice.png
diff --git a/images/更新.png → docs/images/更新.png b/images/更新.png → docs/images/更新.png
diff --git a/docs/images/緑四角ボタン.png b/docs/images/緑四角ボタン.png
diff --git a/images/自動結合開始前.png → docs/images/自動結合開始前.png b/images/自動結合開始前.png → docs/images/自動結合開始前.png
diff --git a/images/自動選択.png → docs/images/自動選択.png b/images/自動選択.png → docs/images/自動選択.png
diff --git a/images/表示行数4.png → docs/images/表示行数4.png b/images/表示行数4.png → docs/images/表示行数4.png
diff --git a/images/表示行数6.png → docs/images/表示行数6.png b/images/表示行数6.png → docs/images/表示行数6.png
diff --git a/images/表示行数設定.png → docs/images/表示行数設定.png b/images/表示行数設定.png → docs/images/表示行数設定.png
diff --git a/docs/images/赤丸ボタン.png b/docs/images/赤丸ボタン.png
diff --git a/docs/images/赤四角ボタン.png b/docs/images/赤四角ボタン.png
diff --git a/docs/merge-umamusume-detail.md b/docs/merge-umamusume-detail.md
@@ -0,0 +1,21 @@
+# レシート因子撮影
+
+## 使い方
+ウマ娘のスキルや因子をレシート因子として撮影します。
+
+![](images/merge_button.png)  
+まずは、ウマ娘詳細の**スキル**または**因子**タブを開きます。  
+赤枠のボタンを押して撮影を開始します。  
+撮影中はボタンが赤色の四角へと変わります。
+その後、ゆっくりとスクロールを行います。  
+一番下までスクロールすると撮影が自動で停止され、スクリーンショット保存先に *combine_YYYY-MM-DD_HH-mm-ss* のファイル名で保存されます。  
+途中で撮影を完了したい場合は赤枠のボタンを押して停止してください。
+停止ボタンを押した際の画面を最後の画像として画像を生成します。
+
+## 各種ボタンの動作
+各ボタンの意味は以下の通りです。  
+|ボタンの種類|意味|  
+|:---:|:---|  
+|![赤丸](images/%E8%B5%A4%E4%B8%B8%E3%83%9C%E3%82%BF%E3%83%B3.png)|停止状態です、押すとキャプチャを開始します。|
+|![緑四角](images/%E7%B7%91%E5%9B%9B%E8%A7%92%E3%83%9C%E3%82%BF%E3%83%B3.png)|スクロールバーが最上部にない状態でキャプチャが開始されました。最上部までスクロールすると撮影がスタートします。|
+|![赤四角](images/%E8%B5%A4%E5%9B%9B%E8%A7%92%E3%83%9C%E3%82%BF%E3%83%B3.png)|キャプチャ中です。手動で結合を停止する場合に押してください。|
diff --git a/docs/recognize-event.md b/docs/recognize-event.md
@@ -0,0 +1,7 @@
+# イベントの認識
+
+## 使い方
+開始するためにはまずスタートボタンを押します。  
+![スタートボタンを押す](images/start.png)  
+その後、通常通り育成を行います。  
+イベントが発生すると自動で認識され、選択肢を画面下部の選択肢に表示します。  
diff --git a/docs/settings.md b/docs/settings.md
@@ -0,0 +1,79 @@
+# 設定画面
+
+![設定画面](images/settingdialog.png)  
+
+## 目次
+- [一般](#一般)
+    - [イベントを更新する](#イベントを更新する)
+    - [ウィンドウのフォント](#ウィンドウのフォント)
+    - [効果テキスト最大行数](#効果テキスト最大行数)
+    - [テーマ](#テーマ)
+    - [「選択肢なし」のイベントを表示しない](#「選択肢なし」のイベントを表示しない)
+    - [ステータスバーを表示する](#ステータスバーを表示する)
+    - [起動時に更新がある場合は通知する](#起動時に更新がある場合は通知する)
+- [OCR設定](#OCR設定)
+    - [OCR数](#OCR数)
+    - [キャプチャ方式](#キャプチャ方式)
+- [スクリーンショット](#スクリーンショット)
+    - [場所](#場所)
+    - [種類](#種類)
+- [デバッグモード](#デバッグモード)
+    - [output.logにデバッグログを出力する](#output.logにデバッグログを出力する)
+    - [イベントを識別できなかった場合にキャプチャする](#イベントを識別できなかった場合にキャプチャする)
+
+## 一般
+
+### イベントを更新する
+サポートカード、育成ウマ娘、シナリオイベントのデータを更新します。  
+
+### ウィンドウのフォント
+フォントやフォントサイズを変更できます。  
+高DPIや大きいディスプレイを使用していてウィンドウが見づらい場合にフォントサイズ等を変えると見やすくなります。
+
+### 効果テキスト最大行数
+表示されているイベントの選択肢を表示するテキストボックスの最大行数を変更します。  
+デフォルトは4が設定されています。
+
+### 「選択肢なし」のイベントを表示しない
+イベントの選択肢が「選択肢なし」となっているイベントは表示しません。  
+選択肢が存在しないイベントが表示されるのが煩わしい場合に有効にします。
+
+### ステータスバーを表示する
+ステータスバーを表示します。  
+CPU、メモリの使用率やウマ娘のウィンドウサイズが表示されます。
+
+### 起動時に更新がある場合は通知する
+起動時に更新があるかチェックを行い、更新がある場合には以下の通知が表示されます。  
+![](images/update_notice.png)  
+**スキップ**を押すとダイアログが閉じます。  
+**更新する**を押すとダウンロードページが開きます。
+
+## OCR設定
+
+### OCR数
+数値を大きくするほど識別が速くなりますが、メモリ使用量も多くなります。  
+1～10までの数値で選択できます。
+
+### キャプチャ方式
+**BitBlt**は従来のキャプチャ方式です。  
+キャプチャする際に他のウィンドウが重なっていると一緒に撮影されてしまいます。  
+**Windows10 (1903以降)**は比較的新しいキャプチャ方式です。  
+ウィンドウが最小化されていてもキャプチャができ、高速です。
+
+## スクリーンショット
+
+### 場所
+スクリーンショットの保存先です。  
+空の場合は実行ファイルと同じディレクトリのscreenshotsフォルダに保存されます。
+
+### 種類
+保存する画像のタイプです。  
+現在はPNG、JPEGをサポートしています。
+
+## デバッグモード
+
+### output.logにデバッグログを出力する
+output.logファイルにデバッグログを出力します。
+
+### イベントを識別できなかった場合にキャプチャする
+認識できなかった場合に画像をスクリーンショット保存先へ自動で保存します。
diff --git a/docs/umamusume-auto-choise.md b/docs/umamusume-auto-choise.md
@@ -0,0 +1,6 @@
+# 育成ウマ娘の自動選択
+
+## 使い方
+自動選択を使用するためにスタートを押します。  
+![スタートボタンを押す](images/start.png)  
+育成ウマ娘を選択時や育成中にウマ娘の詳細を表示すると、自動で認識された場合はコンボボックスに認識されたウマ娘が表示されます。
diff --git a/docs/umamusume-choise.md b/docs/umamusume-choise.md
@@ -0,0 +1,7 @@
+# 育成ウマ娘の選択
+
+全てのイベントを認識するためには育成ウマ娘を選ぶ必要があります。  
+育成ウマ娘を選択するには以下のウィンドウの __育成ウマ娘__ から対象となるウマ娘を選びます。  
+項目の順番は星ごとに表示され、ウマ娘のあいうえお順に並んでいます。
+
+![](images/top.png) 
diff --git a/images/緑四角ボタン.png b/images/緑四角ボタン.png
diff --git a/images/赤丸ボタン.png b/images/赤丸ボタン.png
diff --git a/images/赤四角ボタン.png b/images/赤四角ボタン.png