Skip to content

Latest commit

 

History

History
153 lines (91 loc) · 7.05 KB

README.ja.md

File metadata and controls

153 lines (91 loc) · 7.05 KB
Raw

English / 日本語

Cubism Unity Components

Unity用のCubism SDKのオープンコンポーネントです。

モデルをロードするには Live2D Cubism Core と組み合わせて使用します。

SDKパッケージのダウンロードページをお探しの場合は、ダウンロードページにアクセスしてください。

ライセンス

ご使用前にライセンスをお読みください。

お知らせ

ご使用前にお知らせをお読みください。

Cubism 5新機能や過去バージョンとの互換性について

本 SDK はCubism 5に対応した製品です。
Cubism 5 Editorに搭載された新機能のSDK対応については こちらをご確認ください。
過去バージョンのCubism SDKとの互換性については こちらをご確認ください。

構造

コンポーネント

コンポーネントは役割ごとにグループ化されており、このグループ化はフォルダー構造と名前空間の両方に反映されます。

Coreラッパー

このグループのコンポーネントとクラスは、CubismコアライブラリをC#とUnityにラップするためのレイヤーであり、./Assets/Live2D/Cubism/Coreにあります。

フレームワーク

このグループのコンポーネントとクラスは、リップシンクやCubismの組み込み用ファイルとUnityの統合などの追加機能を提供します。CubismファイルをプレハブとAnimationClipに変換するのはここで行われます。すべてのフレームワークコードは./Assets/Live2D/Cubism/Frameworkにあります。

レンダリング

このグループのコンポーネントとクラスは、Unityの機能を使用してCubismモデルをレンダリングする機能を提供します。コードは、./Assets/Live2D/Cubism/Renderingにあります。

エディター拡張機能

Unity Editor拡張機能は、./Assets/Live2D/Cubism/Editorにあります。

リソース

シェーダー等のアセットのリソースは、./Assets/Live2D/Cubism/Rendering/Resourcesにあります。

開発環境

Unity バージョン
Latest 2023.2.14f1 (*1)
LTS 2022.3.21f1
LTS 2021.3.36f1

*1 ARMv7のAndroidは非対応です。

ライブラリ / ツール バージョン
Android SDK / NDK *2
Visual Studio 2022 17.9.3
Windows SDK 10.0.22621.0
Xcode 15.3

*2 Unityに組み込まれたライブラリまたは推奨ライブラリを使用してください。

HarmonyOS NEXT 対応ツール バージョン
Tuanjie 1.0.1
DevEco Studio *3 4.0

*3 中国国外でのHarmonyOS NEXT向けビルドはDevEcoを通じてビルドする必要があります。

C#コンパイラ

Unity2018.4以降でサポートされているRoslynまたはmcsコンパイラを使用してビルドします。

注：mcsコンパイラは非推奨であり、ビルドのみをチェックします。

使用できるC#のバージョンについては、次の公式ドキュメントを参照してください。

https://docs.unity3d.com/ja/2018.4/Manual/CSharpCompiler.html

テスト済みの環境

プラットフォーム バージョン
Android 14
iOS 17.4
iPadOS 17.4
Ubuntu 20.04.6
macOS 14.4
Windows 11 23H2
Google Chrome 122.0.6261.129
Chrome OS 64bit (x86_64) 122.0.6261.118
Chrome OS 32bit (ARMv8) (*3) 122.0.6261.118
HarmonyOS NEXT 4.0.0.66

*3 Android向けAPKファイルでの動作確認です。

ブランチ

最新の機能や修正をお探しの場合、developブランチをご確認ください。

masterブランチは、公式のSDKリリースごとにdevelopブランチと同期されます。

使用法

./Assetsの下にあるすべてのファイルを、Unityプロジェクト内のLive2DCubismSDKがあるフォルダーにコピーしてください。

unsafeブロック

Coreラッパーでは、unsafeコードのブロックを許可する必要があり、Unityが作成するC#プロジェクトにはそれに応じてパッチが適用されます。unsafeコードを選択できない場合、現在のところ最善の方法は、コンポーネントをコンパイルして、そのdllをUnityプロジェクトに適用することです。

プロジェクトへの貢献

プロジェクトに貢献する方法はたくさんあります。バグのログの記録、このGitHubでのプルリクエストの送信、Live2Dコミュニティでの問題の報告と提案の作成です。

フォークとプルリクエスト

修正、改善、さらには新機能をもたらすかどうかにかかわらず、プルリクエストに感謝します。メインリポジトリを可能な限りクリーンに保つために、必要に応じて個人用フォークと機能ブランチを作成してください。

バグ

Live2Dコミュニティでは、問題のレポートと機能リクエストを定期的にチェックしています。バグレポートを提出する前に、Live2Dコミュニティで検索して、問題のレポートまたは機能リクエストがすでに投稿されているかどうかを確認してください。問題がすでに存在する場合は、関連するコメントを追記してください。

提案

SDKの将来についてのフィードバックにも関心があります。Live2Dコミュニティで提案や機能のリクエストを送信できます。このプロセスをより効果的にするために、それらをより明確に定義するのに役立つより多くの情報を含めるようお願いしています。

コーディングガイドライン

ネーミング

可能な限り、Microsoftガイドラインに準拠するようにしてください。プライベートフィールドには、アンダースコアで始まる小文字の名前を付けます。

スタイル

  • Unity Editor拡張機能では、LINQやその他すべての凝ったものを使って表現力豊かなコードを書いてみてください。
  • それ以外の場所ではLINQを使用せず、foreachよりもforを優先してください。
  • アクセス修飾子を明示的にするようにしてください。void Update()ではなく private void Update()を使いましょう。

フォーラム

ご不明な点がございましたら、公式のLive2Dフォーラムに参加して、他のユーザーと話し合ってください。