https://github.com/yamachu/voicevoxcoresharp
voicevox_core をC# から扱うためのライブラリ
https://github.com/yamachu/voicevoxcoresharp
voicevox
Last synced: 5 months ago
JSON representation
voicevox_core をC# から扱うためのライブラリ
- Host: GitHub
- URL: https://github.com/yamachu/voicevoxcoresharp
- Owner: yamachu
- License: mit
- Created: 2023-08-17T17:26:06.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2025-06-04T10:00:07.000Z (about 1 year ago)
- Last Synced: 2025-06-21T02:52:01.818Z (about 1 year ago)
- Topics: voicevox
- Language: C#
- Homepage:
- Size: 522 KB
- Stars: 20
- Watchers: 3
- Forks: 5
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# VoicevoxCoreSharp
[voicevox_core](https://github.com/voicevox/voicevox_core) を C# から使用するためのラッパー。
薄いラッパーであるため、基本的には voicevox_core のドキュメントを参照し使用できます。
CLI アプリケーションや MAUI、Unity アプリケーションなどで、直接 voicevox_core を扱うことを目的としています。
## Install
[NuGet](https://www.nuget.org/packages/VoicevoxCoreSharp.Core/) からインストールできます。
```bash
$ dotnet add package VoicevoxCoreSharp.Core
```
Unity の場合は Package Manager から以下の URL を追加してください。
`#0.16.0` はバージョンを指定しています。
```
https://github.com/yamachu/VoicevoxCoreSharp.git?path=/src/VoicevoxCoreSharp.Core.Unity#0.16.0
```
MAUI の場合は以下のパッケージを追加すると便利です。
https://www.nuget.org/packages/VoicevoxCoreSharp.MAUI
```bash
$ dotnet add package VoicevoxCoreSharp.MAUI
```
## Usage
このライブラリを使用するには、voicevox_core のライブラリを自身で用意する必要があります。
[voicevox_core](https://github.com/voicevox/voicevox_core) の Release ページから対応するバージョンのライブラリをダウンロードしてください。
それぞれダウンロードしたライブラリを .NET アプリケーションから参照できるように配置してください。
各プラットフォームやアプリケーションの種類によって配置先が異なる場合があります。
以下の Sample に CLI、MAUI、Unity のサンプルがあるため、そのサンプルの csproj などを参考にしてください。
特に MAUI アプリケーションで Android や iOS で使用する場合は、Native Library のパス解決の問題があるため、[VoicevoxCoreSharp.MAUI](./src/VoicevoxCoreSharp.MAUI) を使用することをお勧めします。
## Sample
[examples/cli](./examples/cli) にコマンドラインから実行するサンプル実装があります。
[examples/UnitySample](./examples/UnitySample) に Unity アプリケーションのサンプルがあります。
[examples/MAUI](./examples/MAUI) に MAUI アプリケーションのサンプルがあります。
## Supported
- .NET Standard 2.0
- C# 9.0
- Unity 2021.3 (LTS) を最低限サポートするため
## Notice
本リポジトリは voicevox_core の main ブランチをトラッキングしているため、main ブランチの状態は製品版のリリースとの互換性がない場合があります。
voicevox_core のリリースに合わせて、Release タグや、nuget パッケージを提供しているため、実際に利用する場合はそちらを利用してください。
詳細なトラッキングしているバージョンは Git Submodule として取得している [voicevox_core](./binding/voicevox_core) のコミットハッシュ、もしくは [VoicevoxCoreCommitHash](./src/VoicevoxCoreSharp.Core/VoicevoxCoreSharp.Core.Metas.props) を参照してください。
今後のリリースで、voicevox_engine で利用されている compatible_engine などの対応を検討しています。
## License
[MIT](./LICENSE)