From e9d15aff5d4851a5f895c2a030261a2d9d2b175e Mon Sep 17 00:00:00 2001 From: Hiroshiba Date: Thu, 8 Aug 2024 01:28:03 +0900 Subject: [PATCH] =?UTF-8?q?docs:=20README=E3=81=AE=E3=82=A8=E3=83=B3?= =?UTF-8?q?=E3=82=B8=E3=83=B3=E3=81=AE=E3=83=91=E3=82=B9=E3=81=AB=E3=81=A4?= =?UTF-8?q?=E3=81=84=E3=81=A6=E3=82=82=E3=81=86=E5=B0=91=E3=81=97=E8=A9=B3?= =?UTF-8?q?=E3=81=97=E3=81=8F=E6=A1=88=E5=86=85=20(#2208)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * READMEのエンジンのパスについてもう少し詳しく案内 * 調整 --- CONTRIBUTING.md | 2 +- README.md | 19 ++++++++++++------- 2 files changed, 13 insertions(+), 8 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5a974e6fb4..5e6dcfe71d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -135,7 +135,7 @@ VITE_DEFAULT_ENGINE_INFOS=`[ "uuid": "074fc39e-678b-4c13-8916-ffca8d505d1d", "name": "VOICEVOX Engine", "executionEnabled": true, - "executionFilePath": "vv-engine/run.exe", + "executionFilePath": "C:/Users/(ユーザー名)/AppData/Local/Programs/VOICEVOX/vv-engine/run.exe", "executionArgs": [], "host": "http://127.0.0.1:50021" } diff --git a/README.md b/README.md index 30518730d1..ab3172a3fd 100644 --- a/README.md +++ b/README.md @@ -49,21 +49,26 @@ npm ci ## 実行 -`.env.production`をコピーして`.env`を作成し、`VITE_DEFAULT_ENGINE_INFOS`内の`executionFilePath`に`voicevox_engine`のパスを指定します。 +### エンジンの準備 -[製品版 VOICEVOX](https://voicevox.hiroshiba.jp/) のディレクトリのパスを指定すれば動きます。 +`.env.production`をコピーして`.env`を作成し、`VITE_DEFAULT_ENGINE_INFOS`内の`executionFilePath`に +[製品版 VOICEVOX](https://voicevox.hiroshiba.jp/) 内の`vv-engine/run.exe`を指定すれば動きます。 -Windows の場合でもパスの区切り文字は`\`ではなく`/`なのでご注意ください。 +Windows でインストール先を変更していない場合は`C:/Users/(ユーザー名)/AppData/Local/Programs/VOICEVOX/vv-engine/run.exe`を指定してください。 +パスの区切り文字は`\`ではなく`/`なのでご注意ください。 -また、macOS 向けの`VOICEVOX.app`を利用している場合は`/path/to/VOICEVOX.app/Contents/MacOS/vv-engine/run`を指定してください。 +macOS 向けの`VOICEVOX.app`を利用している場合は`/path/to/VOICEVOX.app/Contents/MacOS/vv-engine/run`を指定してください。 -Linux の場合は、[Releases](https://github.com/VOICEVOX/voicevox/releases/)から入手できる tar.gz 版に含まれる`run`コマンドを指定してください。 +Linux の場合は、[Releases](https://github.com/VOICEVOX/voicevox/releases/)から入手できる tar.gz 版に含まれる`vv-engine/run`コマンドを指定してください。 AppImage 版の場合は`$ /path/to/VOICEVOX.AppImage --appimage-mount`でファイルシステムをマウントできます。 -VOICEVOX エディタの実行とは別にエンジン API のサーバを立てている場合は`executionFilePath`を指定する必要はありません。 +VOICEVOX エディタの実行とは別にエンジン API のサーバを立てている場合は`executionFilePath`を指定する必要はありませんが、 +代わりに`executionEnabled`を`false`にしてください。 これは製品版 VOICEVOX を起動している場合もあてはまります。 -また、エンジン API の宛先エンドポイントを変更する場合は`VITE_DEFAULT_ENGINE_INFOS`内の`host`を変更してください。 +エンジン API の宛先エンドポイントを変更する場合は`VITE_DEFAULT_ENGINE_INFOS`内の`host`を変更してください。 + +### Electron の実行 ```bash # 開発しやすい環境で実行