Skip to content

Latest commit

 

History

History
207 lines (157 loc) · 6.93 KB

README_EN.md

File metadata and controls

207 lines (157 loc) · 6.93 KB

uDesktopMascot

Unity Version Releases Unity Test CI

Japanese | English | 中文 | Español | Français

Note: The languages provided above (English, 中文, Español, Français) were generated through automatic translation by GPT-4o-mini. For accuracy and nuance in translation, please refer to the original text (Japanese).

Overview

"uDesktopMascot" is an open-source project for a desktop mascot application themed around "liberation of creativity." As an example of its functionality, it can load models in VRM or GLB/FBX formats and display them on the desktop. You can also freely set the colors and background images of GUI elements like menus and application windows. For a detailed list of features, please refer to the Features List.

Supported Platforms

  • Windows 10/11
  • macOS

Features List

The application has the following features implemented. For details, please see the list below.

External assets can be added by placing them in the StreamingAssets folder.

Models and Animations
  • Displays any model file placed in the StreamingAssets.
    • Supports VRM (1.x, 0.x) format models.
    • Supports GLB/GLTF format models (animations are not supported).
    • Supports FBX format models (however, some models may not load textures, and animations are not supported).
      • Textures can be loaded by placing them in StreamingAssets/textures/.
  • Adds VRM models from model selection/addition screen.
    • Add by specifying a path.
    • Add through the file selection dialog.
Voice and BGM
  • Loads and plays audio files placed in SteamingAssets/Voice/. If there are multiple files, they are played randomly.
    • Audio that plays on click is loaded from audio files placed in StreamingAssets/Voice/Click/.
  • Loads and plays music files placed in SteamingAssets/BGM/. If there are multiple files, they are played randomly.
  • Adds default voice for the character.
    • The default voice uses the audio from COEIROINK: Tsukuyomi-chan.
    • Played at application launch, application exit, and on click.
Application Settings via Text File

You can change application settings via the application_settings.txt file.

The structure of the settings file is as follows:

[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
Menu Screen
  • You can set the background image and background color of the menu screen.
    • The background image can be loaded from image files placed in StreamingAssets/Menu/. The supported image formats are:
      • PNG
      • JPG (JPEG)
      • BMP
      • GIF (static image)
      • TGA
      • TIFF
    • The background color can be specified with a color code.
  • Access the following functions from the menu screen:
    • Model selection and addition screen
    • AI chat feature
    • LocalWeb feature
    • Application settings
    • Exit application
  • By pressing the minimize button on the menu screen, the application can be minimized to the notification area (Windows only).
    • Minimized applications can be restored by clicking the notification area icon.

Running on macOS

When running the application on macOS, the application may be blocked by GateKeeper. In that case, please run the following command from the terminal:

xattr -r -c uDesktopMascot.app

Requirements

  • Unity 6000.0.31f1 (IL2CPP)

License

Resources

How to Create an Installer

Windows

  • Build in Unity to create a folder named uDesktopMascot within the build folder.
uDesktopMascot
└── build
    └── uDesktopMascot
        ├── uDesktopMascot.exe
        └── README.txt
        ...

  • Install Inno Setup.

  • Once opened, click More files and select setup.iss found within the project directory.

  • After selection, click the play button.

  • Once the build is complete, the installer will be generated in the project root.

macOS

The installer can only be created on a macOS PC.

  • Build in Unity to create a folder named uDesktopMascot within the build/uDesktopMascot folder.
uDesktopMascot
└── build
    └── uDesktopMascot
        ├── uDesktopMascot.app
        └── README.txt
  • Execute the following command:
cd build
productbuild --component uDesktopMascot/uDesktopMascot.app /Applications ./uDesktopMascot_mac_installer.pkg
  • Once the build is complete, the uDesktopMascot_mac_installer.pkg will be generated in the build folder.

Creator Credits

  • Model: "Aozora"
  • BGM: MidraLab (eisuke)
  • Software Icon: Yamucha

3rd Party Notices

See NOTICE.

Sponsor

  • Luna
  • uezo