Release of Cubism 5 SDK for Unreal Engine R1 alpha1

.gitignore

@@ -0,0 +1,2 @@
+Binaries
+Intermediate

CHANGELOG.md

@@ -0,0 +1,12 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
+
+
+## [5-r.1-alpha.1] - 2024-09-05
+
+### Added
+
+* New released!

Config/FilterPlugin.ini

@@ -0,0 +1,7 @@
+[FilterPlugin]
+; This section lists additional files which will be packaged along with your plugin. Paths should be listed relative to the root plugin directory, and
+; may include "...", "*", and "?" wildcards to match directories, files, and individual characters respectively.
+;
+; Examples:
+;    /README.txt
+;    /Extras/...

LICENSE.md

@@ -0,0 +1,61 @@
+## Definitions
+
+### Live2D Cubism Components
+
+Cubism Unreal Engine Components is included in Live2D Cubism Components.
+
+Cubism Unreal Engine Components は Live2D Cubism Components に含まれます。
+
+Cubism Unreal Engine Components 包括在 Live2D Cubism Components 中。
+
+## Cubism SDK Release License
+
+*All business* users must obtain a Cubism SDK Release License. "Business" means an entity with the annual gross revenue more than ten million (10,000,000) JPY for the most recent fiscal year.
+
+* [Cubism SDK Release License](https://www.live2d.com/en/download/cubism-sdk/release-license/)
+
+直近会計年度の売上高が 1000 万円以上の事業者様がご利用になる場合は、Cubism SDK リリースライセンス（出版許諾契約）に同意していただく必要がございます。
+
+* [Cubism SDK リリースライセンス](https://www.live2d.com/ja/download/cubism-sdk/release-license/)
+
+如果您的企业在最近一个会计年度的销售额达到或超过1000万日元，您必须得到Cubism SDK的出版授权许可（出版许可协议）。
+
+* [Cubism SDK发行许可证](https://www.live2d.com/zh-CHS/download/cubism-sdk/release-license/)
+
+
+## Live2D Open Software License
+
+Live2D Cubism Components is available under Live2D Open Software License.
+
+* [Live2D Open Software License Agreement](https://www.live2d.com/eula/live2d-open-software-license-agreement_en.html)
+* [Live2D Open Software 使用許諾契約書](https://www.live2d.com/eula/live2d-open-software-license-agreement_jp.html)
+* [Live2D Open Software 使用授权协议](https://www.live2d.com/eula/live2d-open-software-license-agreement_cn.html)
+
+
+## Live2D Proprietary Software License
+
+Live2D Cubism Core is available under Live2D Proprietary Software License.
+
+* [Live2D Proprietary Software License Agreement](https://www.live2d.com/eula/live2d-proprietary-software-license-agreement_en.html)
+* [Live2D Proprietary Software 使用許諾契約書](https://www.live2d.com/eula/live2d-proprietary-software-license-agreement_jp.html)
+* [Live2D Proprietary Software 使用授权协议](https://www.live2d.com/eula/live2d-proprietary-software-license-agreement_cn.html)
+
+
+## Free Material License
+
+Live2D models listed below are available under Free Material License.
+
+* [Free Material License Agreement](https://www.live2d.com/eula/live2d-free-material-license-agreement_en.html)
+* [無償提供マテリアルの使用許諾契約書](https://www.live2d.com/eula/live2d-free-material-license-agreement_jp.html)
+* [无偿提供素材使用授权协议](https://www.live2d.com/eula/live2d-free-material-license-agreement_cn.html)
+
+```
+Content/Samples/Models/Mao
+```
+
+If you use these models, you must agree to the terms of a contract set [here](https://docs.live2d.com/cubism-editor-manual/sample-model/) for each model.
+
+
+---
+
+Please contact us from [here](https://www.live2d.jp/contact/) for more license information.

Live2DCubismSDK.uplugin

@@ -0,0 +1,34 @@
+{
+	"FileVersion": 3,
+	"Version": 1,
+	"VersionName": "5-r.1-alpha.1",
+	"FriendlyName": "Live2DCubismSDK",
+	"Description": "Live2D Cubism SDK for Unreal Engine Components",
+	"Category": "Other",
+	"CreatedBy": "Live2D Inc,",
+	"CreatedByURL": "https://www.live2d.com/",
+	"DocsURL": "https://docs.live2d.com/cubism-sdk-manual/top/",
+	"MarketplaceURL": "",
+	"SupportURL": "",
+	"CanContainContent": true,
+	"IsBetaVersion": true,
+	"IsExperimentalVersion": true,
+	"Installed": false,
+	"Modules": [
+		{
+			"Name": "Live2DCubismFramework",
+			"Type": "Runtime",
+			"LoadingPhase": "PostConfigInit"
+		},
+		{
+			"Name": "Live2DCubismFrameworkEditor",
+			"Type": "Editor",
+			"LoadingPhase": "Default"
+		},
+		{
+			"Name": "Live2DCubismFrameworkImporter",
+			"Type": "Editor",
+			"LoadingPhase": "Default"
+		}
+	]
+}

NOTICE.ja.md

@@ -0,0 +1,53 @@
+[English](NOTICE.md) / [日本語](NOTICE.ja.md)
+
+---
+
+# お知らせ
+
+## [制限事項] alpha版における機能制限について (2024-09-05)
+
+### レベル
+
+alpha版ではOpenWorldレベルでの利用に対応しておりません。
+ご利用時はBasicレベルでの利用をお願いいたします。
+
+### モデルの表示
+
+#### モデルテクスチャ
+
+現在モデルのテクスチャが1024x1024 1枚の場合に正常に描画されない問題を確認しています。
+これを回避するにはCubism Editorにてテクスチャアトラスを1024x1024 1枚以外(2048x2048 1枚、1024x1024 2枚 等)に設定し再度書き出し直したモデルをインポートしてください。
+
+#### ピューポート表示
+
+レベルにLive2Dモデルをスポーンした直後正しく表示されない場合があります。
+その際はビューポートのリアルタイム更新機能をONにして画面を更新してください。
+
+### ダブルバッファリング
+
+alpha版ではモバイル端末上でのパフォーマンス向上のためのダブルバッファリングは実装されていません。
+
+### 再インポート機能
+
+alpha版では組み込み用ファイルの再インポート機能が実装されていません。
+再インポートを行う場合は、インポート済みのアセットを削除してから再度インポートを行ってください。
+
+### コンポーネント
+
+各コンポーネントのプロパティ値を変更しPlayした際、Playする前に変更した値が反映されない問題を確認しています。
+これを回避するには該当するコンポーネントをもう一度アタッチし直してください。
+
+### Unreal Editorのデバッグ機能使用時
+
+デバッグ機能使用時、CubismPoseで使われている非実在パラメータの値が正しく取得できない問題を確認しています。
+通常のプロジェクト実行時は問題ありません。
+
+### 書き出し
+
+現在Windows以外の書き出しに対応しておりません。
+対応プラットフォームについては順次対応予定です。
+なおalpha版を利用してのコンテンツリリースは仕様が大幅に変更される可能性があるため、ご遠慮ください。
+
+---
+
+©Live2D

NOTICE.md

@@ -0,0 +1,53 @@
+[English](NOTICE.md) / [日本語](NOTICE.ja.md)
+
+---
+
+# Notices
+
+## [Restrictions] Feature Restrictions in the Alpha Version (2024-09-05)
+
+
+### Level
+
+The alpha version does not support the use of OpenWorld levels. Please use the Basic level during your usage.
+
+### Display the model 
+
+#### Model Textures
+
+We have identified an issue where models with a single 1024x1024 texture do not render correctly.
+To avoid this issue, please adjust the texture atlas in Cubism Editor to anything other than a single 1024x1024 (e.g., a single 2048x2048, or two 1024x1024 textures), then re-export and re-import the model.
+
+### Viewport Display
+
+Live2D models may not display correctly immediately after being spawned in a level.
+In such cases, please enable the real-time update feature in the viewport to refresh the screen.
+
+### Double Buffering
+
+Double buffering for performance improvement on mobile devices is not implemented in the alpha version.
+
+### Assets Reimport
+
+The assets reimport feature for embedded files is not implemented in the alpha version. 
+If you need to reimport, please delete the imported assets and then reimport them.
+
+### Components
+
+We have identified an issue where property values changed in each component are not reflected when you play after making changes. 
+To avoid this issue, please re-attach the relevant component.
+
+### Using Unreal Editor's Debugging
+
+We have identified an issue where the values of non-existing parameters used in CubismPose cannot be correctly retrieved when using the debug. 
+There is no problem during the execution of the project.
+
+### Export
+
+The alpha version does not support exporting on platforms other than Windows.
+Support for additional platforms will be implemented sequentially.
+Please note that releasing content using the alpha version is not recommended, as significant changes to the specifications may occur.
+
+---
+
+©Live2D

README.ja.md

@@ -0,0 +1,116 @@
+[English](README.md) / [日本語](README.ja.md)
+
+---
+
+# Cubism Unreal Engine Components
+
+Unreal Engine用のCubism SDKのオープンコンポーネントです。
+
+モデルをロードするには Live2D Cubism Core と組み合わせて使用します。
+
+SDKパッケージのダウンロードページをお探しの場合は、[ダウンロードページ](https://creatorsforum.live2d.com/c/cubism-sdk-ue-alpha/download/132)にアクセスしてください。
+
+## プレリリース版ソフトウェア
+
+本製品は「プレリリース版ソフトウェア」です。
+
+プレリリース版ソフトウェアは、Live2D社から提供される最終製品に相当するものではなく、バグ、エラーおよびシステム障害等またはデータの損失につながるその他の不具合を含む可能性があります。
+
+詳しくは、[ライセンス](LICENSE.md)をお読みください。
+
+## ライセンス
+
+ご使用前に[ライセンス](LICENSE.md)をお読みください。
+
+## お知らせ
+
+ご使用前に[お知らせ](NOTICE.ja.md)をお読みください。
+
+
+## Cubism 5新機能や過去バージョンとの互換性について
+
+本 SDK はCubism 5に対応した製品です。  
+Cubism 5 Editorに搭載された新機能のSDK対応については [こちら](https://docs.live2d.com/cubism-sdk-manual/cubism-5-new-functions/)をご確認ください。  
+過去バージョンのCubism SDKとの互換性については [こちら](https://docs.live2d.com/cubism-sdk-manual/compatibility-with-cubism-5/)をご確認ください。
+
+## 構造
+
+### コンポーネント
+
+コンポーネントは役割ごとにグループ化されており、このグループ化はフォルダー構造と名前空間の両方に反映されます。
+
+#### フレームワーク
+
+このグループのコンポーネントとクラスは、リップシンクやCubismの組み込み用ファイルとUnreal Engineの統合などの追加機能を提供します。すべてのフレームワークコードは`./Source/Live2DCubismFramework`にあります。
+
+#### レンダリング
+
+このグループのコンポーネントとクラスは、Unreal Engineの機能を使用してCubismモデルをレンダリングする機能を提供します。コードは、`./Source/Live2DCubismFramework/Public/Rendering`及び`./Source/Live2DCubismFramework/Private/Rendering`にあります。
+
+### エディター拡張機能
+
+Unreal Engine Editor拡張機能は、`./Source/Live2DCubismFrameworkEditor`にあります。
+
+### インポーター機能
+
+Cubismファイルをuassetファイルに変換する機能は `./Source/Live2DCubismFrameworkImporter`にあります。
+
+### リソース
+
+シェーダー等のアセットのリソースは、`./Content/Materials`にあります。
+
+## 開発環境
+
+| Unreal Engine | バージョン |
+| --- | --- |
+| Unreal Editor | 5.3.2 |
+
+| ライブラリ / ツール | バージョン |
+| --- | --- |
+| Visual Studio 2022 | 17.9.3 |
+| Windows SDK | 10.0.22621.0 |
+
+## テスト済みの環境
+
+| プラットフォーム | バージョン |
+| --- | --- |
+| Windows 11 | 23H2 |
+
+
+## ブランチ
+
+最新の機能や修正をお探しの場合、`develop`ブランチをご確認ください。
+
+`master`ブランチは、公式のSDKリリースごとに`develop`ブランチと同期されます。
+
+## 使用法
+
+Unreal プロジェクトをC++で作成し、Unreal プロジェクトの下に`Plugins`フォルダを作成した後、パッケージフォルダごと作成した`Plugins`フォルダーにコピーしてUnreal Engineを起動し直してください。
+詳しくは[公式マニュアル](https://docs.live2d.com/cubism-sdk-manual/cubism-sdk-for-unreal-engine/)をご確認ください。
+
+## プロジェクトへの貢献
+
+プロジェクトに貢献する方法はたくさんあります。バグのログの記録、このGitHubでのプルリクエストの送信、Live2Dコミュニティでの問題の報告と提案の作成です。
+
+### フォークとプルリクエスト
+
+修正、改善、さらには新機能をもたらすかどうかにかかわらず、プルリクエストに感謝します。メインリポジトリを可能な限りクリーンに保つために、必要に応じて個人用フォークと機能ブランチを作成してください。
+
+### バグ
+
+Live2Dコミュニティでは、問題のレポートと機能リクエストを定期的にチェックしています。バグレポートを提出する前に、Live2Dコミュニティで検索して、問題のレポートまたは機能リクエストがすでに投稿されているかどうかを確認してください。問題がすでに存在する場合は、関連するコメントを追記してください。
+
+### 提案
+
+SDKの将来についてのフィードバックにも関心があります。Live2Dコミュニティで提案や機能のリクエストを送信できます。このプロセスをより効果的にするために、それらをより明確に定義するのに役立つより多くの情報を含めるようお願いしています。
+
+## コーディングガイドライン
+
+Unreal Engine公式の[Unreal Engine における Epic の C++ コーディング規約](https://dev.epicgames.com/documentation/ja-jp/unreal-engine/epic-cplusplus-coding-standard-for-unreal-engine) に則っています。
+
+## フォーラム
+
+ご不明な点がございましたら、公式のLive2Dフォーラムに参加して、他のユーザーと話し合ってください。
+
+- [Live2D 公式クリエイターズフォーラム](https://creatorsforum.live2d.com/)
+- [Live2D Creators Forum(English)](https://community.live2d.com/)