# uDesktopMascot [![Unity Version](https://camo.githubusercontent.com/e48dfb4cfe8b61e28b0fc79070e9d95e65a23728215140c30400f990c1225247/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f556e6974792d363030302e302532422d626c756576696f6c65743f6c6f676f3d756e697479)](https://unity.com/releases/editor/archive) 日本語 | [English](https://github.com/MidraLab/uDesktopMascot/blob/develop/README_EN.md) | [中文](https://github.com/MidraLab/uDesktopMascot/blob/develop/README_CN.md) | [Español](https://github.com/MidraLab/uDesktopMascot/blob/develop/README_ES.md) | [Français](https://github.com/MidraLab/uDesktopMascot/blob/develop/README_FR.md) **注意**: 上記の言語（English、中文、Español、Français）は、GPT-4o-miniによる自動翻訳で生成されています。翻訳の精度やニュアンスに関しては、原文（日本語）をご参照ください。 * [uDesktopMascot](https://github.com/MidraLab/uDesktopMascot/raw/develop/#udesktopmascot) * [概要](https://github.com/MidraLab/uDesktopMascot/raw/develop/#概要) * [機能一覧](https://github.com/MidraLab/uDesktopMascot/raw/develop/#機能一覧) * [macOSでの実行について](https://github.com/MidraLab/uDesktopMascot/raw/develop/#macosでの実行について) * [requirements](https://github.com/MidraLab/uDesktopMascot/raw/develop/#requirements) * [license](https://github.com/MidraLab/uDesktopMascot/raw/develop/#license) * [素材について](https://github.com/MidraLab/uDesktopMascot/raw/develop/#素材について) * [インストーラー作成方法](https://github.com/MidraLab/uDesktopMascot/raw/develop/#インストーラー作成方法) * [Windows](https://github.com/MidraLab/uDesktopMascot/raw/develop/#windows) * [macOS](https://github.com/MidraLab/uDesktopMascot/raw/develop/#macos) * [制作者クレジット](https://github.com/MidraLab/uDesktopMascot/raw/develop/#制作者クレジット) * [3rd Party Notices](https://github.com/MidraLab/uDesktopMascot/raw/develop/#3rd-party-notices) * [sponsor](https://github.com/MidraLab/uDesktopMascot/raw/develop/#sponsor) ## 概要「uDesktopMascot」は、`創作の自由化` をテーマにしたデスクトップマスコットアプリケーションのオープンソースプロジェクトです。一機能の例としてVRMやGLB/FBX形式のモデルを読み込み、デスクトップ上に表示することができます。またメニュー画面やアプリケーションウインドウなどのGUIの色や背景画像を自由に設定することもできます。詳しい機能一覧は [機能一覧](https://github.com/MidraLab/uDesktopMascot/raw/develop/#機能一覧) を参照してください。 ![](https://github.com/MidraLab/uDesktopMascot/raw/develop/Docs/Image/AppImage.png) **対応プラットフォーム** * Windows 10/11 * macOS ## 機能一覧アプリには以下の機能が実装されています。詳細は以下のリストを参照してください。外部アセットの追加は、StreamingAssetsフォルダに配置することで実現できます。

モデル・アニメーション

* StreamingAssetsに配置した任意モデルファイルを読み込んで表示します。 * VRM(1.x, 0.x)形式のモデルをサポートしています。 * GLB/GLTF形式のモデルをサポートしています。(アニメーションは対応していません) * FBX形式のモデルをサポートしています。(ただし一部のモデルではテクスチャーがロードができません。またアニメーションは対応していません) * テクスチャーは StreamingAssets/textures/ に配置することで読み込むことができます。 * モデル選択・追加画面からVRMモデルの追加 * パスを指定して追加 * ファイル選択ダイアログから追加

ボイス・BGM

* SteamingAssets/Voice/以下に配置した音声ファイルを読み込んで再生します。複数ある場合は、ランダムで再生します。 * クリック時に再生される音声は、StreamingAssets/Voice/Click/に配置した音声ファイルを読み込んで再生します。 * SteamingAssets/BGM/以下に配置した音楽ファイルを読み込んで再生します。複数ある場合は、ランダムで再生します。 * キャラクターのデフォルトのボイスの追加 * デフォルトのボイスは、[COEIROINK:つくよみちゃん](https://coeiroink.com/character/audio-character/tsukuyomi-chan)の音声を使用しています。 * アプリ起動時、アプリ終了時、クリック時に再生されます。

テキストファイルによるアプリケーション設定

application_settings.txtファイルにより、アプリケーションの設定を変更できます。設定ファイルの構造は以下になっています ```txt [Character] ModelPath=default.vrm TexturePaths=test.png Scale=3 PositionX=0 PositionY=0 PositionZ=0 RotationX=0 RotationY=0 RotationZ=0 [Sound] VoiceVolume=1 BGMVolume=0.5 SEVolume=1 [Display] Opacity=1 AlwaysOnTop=True [Performance] TargetFrameRate=60 QualityLevel=2 ```

メニュー画面

* メニュー画面の背景画像および背景色を設定できます。 * 背景画像は、StreamingAssets/Menu/ に配置した画像ファイルを読み込むことができます。対応している画像フォーマットは以下です * PNG * JPG(JPEG) * BMP * GIF(静止画) * TGA * TIFF * 背景色は、カラーコードを指定することができます。 * メニュー画面から以下の機能にアクセス可能 * モデル選択・追加画面 * AIチャット機能 * LocalWeb機能 * アプリケーション設定 * アプリケーション終了 * メニュー画面の収納ボタンを押すことで、Windowsのみ通知領域にアプリケーションを収納できます。 * 収納したアプリケーションは、通知領域のアイコンをクリックすることで、再度表示できます。

## macOSでの実行について macOSでアプリを実行する際、GateKeeperによってアプリがブロックされる場合があります。その場合、ターミナルから以下のコマンドを実行してください。 ```sh xattr -r -c uDesktopMascot.app ``` ## requirements * Unity 6000.1.1f1(IL2CPP) ## license * コードは[Apache License 2.0](https://github.com/MidraLab/uDesktopMascot/raw/develop/LICENSE)に基づいてライセンスされています。 * 以下のアセットは、[CC BY-NC 4.0](https://creativecommons.org/licenses/by-nc/4.0/)に基づいてライセンスされています。 * BGM * モデル ## 素材について * デフォルトのキャラクターアニメーションは、[『VRMお人形遊び』用アニメーションデータ詰め合わせ](https://fumi2kick.booth.pm/items/1655686)を用いて作成されています。リポジトリに含めて配布することに関して、確認済みです。 * フォントは[Noto Sans Japanese](https://fonts.google.com/noto/specimen/Noto+Sans+JP?lang=ja_Jpan)です。[SIL OPEN FONT LICENSE Version 1.1](https://fonts.google.com/noto/specimen/Noto+Sans+JP/license?lang=ja_Jpan)に基づきNoto Sans JPフォントを再配布するものです。フォントの著作権は元の作者（Google）にあります。 * デフォルトボイスは、[COEIROINK:つくよみちゃん](https://coeiroink.com/character/audio-character/tsukuyomi-chan)の音声を使用しています。使用方法については、COEIROINK側に事前に確認済みです * ボタンアイコンは、[MingCute](https://github.com/MidraLab/MingCute)を使用しています。 ## インストーラー作成方法 ### Windows * Unityで`build`フォルダに`uDesktopMascot`という名前でビルドする。 ``` uDesktopMasscot └── build └── uDesktopMasscot ├── uDesktopMascot.exe └── README.txt ... ``` * [Inno Setup](https://www.jrsoftware.org/isdl.php) をインストールする。 * 開いたら、`More files`をクリックして、プロジェクト配下にある`setup.iss`を選択する。 ![](https://github.com/MidraLab/uDesktopMascot/raw/develop/Docs/Image/SetupIss-1.png) * 選択したら、再生ボタンをクリックする。 ![](https://github.com/MidraLab/uDesktopMascot/raw/develop/Docs/Image/SetupIss-2.png) * ビルドが完了したら、プロジェクトのRootにインストーラーが生成されます。 ### macOS macOSのPCでのみインストーラーを作成できます。 * Unityで`build/uDesktopMascot`フォルダに`uDesktopMascot`という名前でビルドする。 ``` uDesktopMasscot └── build └── uDesktopMasscot ├── uDesktopMascot.app └── README.txt ``` * 以下のコマンドを実行する。 ```sh cd build productbuild --component uDesktopMascot/uDesktopMascot.app /Applications ./uDesktopMascot_mac_installer.pkg ``` * ビルドが完了したら、`build`フォルダに`uDesktopMascot_mac_installer.pkg`が生成されます。 ## 制作者クレジット * モデル: 「アオゾラ」様 * BGM: MidraLab(eisuke) * ソフトウェアアイコン: やむちゃ様 ## 3rd Party Notices See [NOTICE](https://github.com/MidraLab/uDesktopMascot/blob/develop/NOTICE.md). ## sponsor - Luna - uezo