Skip to main content

Official Mods

MODs extend Desktop Homunculus with characters, animations, sound effects, UI panels, and integrations. The following official MODs are maintained as part of the project.

MOD List

MODDescriptionInstall
@hmcs/assetsDefault VRM character model, VRMA animations, and sound effectsRecommended
@hmcs/elmerDefault character that spawns Elmer with idle, grab, and sitting animationsRecommended
@hmcs/menuRight-click context menu with a WebView-based HUD overlayRecommended
@hmcs/character-settingsPer-character settings panel (name, scale, persona, OCEAN traits)Recommended
@hmcs/settingsApplication settings panel (frame rate, shadow opacity) via system trayRecommended
@hmcs/voicevoxText-to-speech integration using the VoiceVox engineOptional

Managing MODs

List installed MODs

hmcs mod list

Example output:

 NAME           VERSION  DESCRIPTION
@hmcs/elmer 1.0.0 Default character model
@hmcs/menu 1.0.0 Context menu

Install a MOD

hmcs mod install <package>...

For example, to install the VoiceVox MOD:

hmcs mod install @hmcs/voicevox

Uninstall a MOD

hmcs mod uninstall <package>...

For detailed CLI reference, see hmcs mod.