VOICEVOX のエディターです。
（エンジンは VOICEVOX ENGINE 、 コアは VOICEVOX CORE 、 全体構成は こちら に詳細があります。）
こちらは開発用のページになります。利用方法に関してはVOICEVOX 公式サイト をご覧ください。
VOICEVOX のエディタは Electron・TypeScript・Vue・Vuex などが活用されており、全体構成がわかりにくくなっています。
コードの歩き方で構成を紹介しているので、開発の一助になれば幸いです。
Issue を解決するプルリクエストを作成される際は、別の方と同じ Issue に取り組むことを避けるため、 Issue 側で取り組み始めたことを伝えるか、最初に Draft プルリクエストを作成してください。
VOICEVOX 非公式 Discord サーバーにて、開発の議論や雑談を行っていま 8000 。気軽にご参加ください。
UX・UI デザインの方針をご参照ください。
.node-version に記載されているバージョンの Node.js をインストールしてください。
Node.js の管理ツール（nvsやVoltaなど）を利用すると簡単にインストールでき、Node.js の自動切り替えもできます。
Node.js をインストール後、このリポジトリ を
Fork して git clone し、次のコマンドを実行してください。
npm ci.env.productionをコピーして.envを作成し、VITE_DEFAULT_ENGINE_INFOS内のexecutionFilePathにvoicevox_engineのパスを指定します。
製品版 VOICEVOX のディレクトリのパスを指定すれば動きます。
Windows の場合でもパスの区切り文字は\ではなく/なのでご注意ください。
また、macOS 向けのVOICEVOX.appを利用している場合は/path/to/VOICEVOX.app/Contents/MacOS/runを指定してください。
Linux の場合は、Releasesから入手できる tar.gz 版に含まれるrunコマンドを指定してください。
AppImage 版の場合は$ /path/to/VOICEVOX.AppImage --appimage-mountでファイルシステムをマウントできます。
VOICEVOX エディタの実行とは別にエンジン API のサーバを立てている場合はexecutionFilePathを指定する必要はありません。
これは製品版 VOICEVOX を起動している場合もあてはまります。
また、エンジン API の宛先エンドポイントを変更する場合はVITE_DEFAULT_ENGINE_INFOS内のhostを変更してください。
npm run electron:serve音声合成エンジンのリポジトリはこちらです https://github.com/VOICEVOX/voicevox_engine
別途音声合成エンジンを起動し、以下を実行して表示された localhost へアクセスします。
npm run browser:serveまた、main ブランチのビルド結果がこちらにデプロイされています https://voicevox-browser-dev.netlify.app/
今はローカル PC 上で音声合成エンジンを起動する必要があります。
npm run electron:buildfork したリポジトリで Actions を ON にし、workflow_dispatch でbuild.ymlを起動すればビルドできます。
成果物は Release にアップロードされます。
npm run test:unit
npm run test-watch:unit # 監視モード
npm run test:unit -- --update # スナップショットの更新Electron の機能が不要な、UI や音声合成などの End to End テストを実行します。
Note 一部のエンジンの設定を書き換えるテストは、CI(Github Actions)上でのみ実行されるようになっています。
npm run test:browser-e2e
npm run test-watch:browser-e2e # 監視モード
npm run test-watch:browser-e2e -- --headed # テスト中の UI を表示Playwright を使用しているためテストパターンを生成することもできます。 ブラウザ版を起動している状態で以下のコマンドを実行してください。
npx playwright codegen http://localhost:5173/ --viewport-size=1024,630詳細は Playwright ドキュメントの Test generator を参照してください。
ブラウザ End to End テストでは Visual Regression Testing を行っています。 現在 VRT テストは Windows のみで行っています。 以下の手順でスクリーンショットを更新できます：
-
フォークしたリポジトリの設定で GitHub Actions を有効にします。
-
リポジトリの設定の Actions > General > Workflow permissions で Read and write permissions を選択します。
-
[update snapshots]という文字列をコミットメッセージに含めてコミットします。git commit -m "UIを変更 [update snapshots]" -
Github Workflow が完了すると、更新されたスクリーンショットがコミットされます。
ローカル PC の OS に対応したもののみが更新されます。
npm run test:browser-e2e -- --update-snapshotsElectron の機能が必要な、エンジン起動・終了などを含めた End to End テストを実行します。
npm run test:electron-e2e
npm run test-watch:electron-e2e # 監視モード依存ライブラリのライセンス情報は Github Workflow でのビルド時に自動生成されます。以下のコマンドで生成できます。
# get licenses.json from voicevox_engine as engine_licenses.json
npm run license:generate -- -o voicevox_licenses.json
npm run license:merge -- -o public/licenses.json -i engine_licenses.json -i voicevox_licenses.jsonコードのフォーマットを整えます。プルリクエストを送る前に実行してください。
npm run fmttypos を使ってタイポのチェックを行っています。 typos をインストール した後
typosでタイポチェックを行えます。
もし誤判定やチェックから除外すべきファイルがあれば
設定ファイルの説明 に従って_typos.tomlを編集してください。
TypeScript の型チェックを行います。
npm run typecheckMarkdown の文法チェックを行います。
npm run markdownlintShellScript の文法チェックを行います。 インストール方法は こちら を参照してください。
shellcheck ./build/*.sh音声合成エンジンが起動している状態で以下のコマンドを実行してください。
curl http://127.0.0.1:50021/openapi.json >openapi.json
npx openapi-generator-cli generate \
-i openapi.json \
-g typescript-fetch \
-o src/openapi/ \
--additional-properties "modelPropertyNaming=camelCase,supportsES6=true,withInterfaces=true,typescriptThreePlus=true"
npm run fmt新しいバージョンの確認・インストールは次のコマンドで行えます。
npx openapi-generator-cli version-manager listnpm scripts の serve や electron:serve などの開発ビルド下では、ビルドに使用している vite で sourcemap を出力するため、ソースコードと出力されたコードの対応付けが行われます。
.vscode/launch.template.json をコピーして .vscode/launch.json を作成することで、開発ビルドを VS Code から実行し、デバッグを可能にするタスクが有効になります。
LGPL v3 と、ソースコードの公開が不要な別ライセンスのデュアルライセンスです。
別ライセンスを取得したい場合は、ヒホに求めてください。
X アカウント: @hiho_karuta