MochiPaw

MochiPaw is a Tauri + Vue desktop pet app based on BongoCat.

This repository contains BongoCat-derived material under the MIT License and CatStack-authored additions under the PolyForm Noncommercial License 1.0.0. See NOTICE.md for license scope, attribution, core usage rules, and commercial licensing information.

Noncommercial only. Commercial use requires prior written permission from CatStack / InfinityXCat.

Features

• Customizable Live2D desktop pet in a transparent, always-on-top window.
• Keyboard, mouse, and gamepad input that drives typing behaviors, motions, and expressions.
• Import, organize, rename, and manage multiple Live2D models and desktop pets.
• Built-in Pomodoro timer and daily typing statistics.
• Tray controls, preferences, global shortcuts, autostart, and update management.
• Windows compatibility features, including game mode, Raw Input support, administrator status, and process diagnostics.
• Cross-platform support for Windows, macOS, and Linux.

For global keyboard and mouse input on Linux Wayland, see the input service and evdev setup guide. AppImage can use an installed input service or direct evdev with the current user's device read permissions.

Requirements

• Node.js 22 or newer
• pnpm
• Rust stable toolchain
• Tauri desktop build prerequisites for your OS
• Windows releases include the WebView2 Evergreen bootstrapper. Existing installations are checked before repair and their application data is kept.

Install dependencies:

pnpm install

Development

Start the Tauri development app:

pnpm tauri dev

Start only the Vite dev server:

pnpm dev:vite

Generate app icons:

pnpm build:icon

Build

Build only the frontend:

pnpm build:vite

Build frontend and regenerate icons:

pnpm build

Build the Tauri app for the current platform:

pnpm tauri build

Release builds cover Windows, macOS, and Linux:

Windows: target/release/bundle/msi/ and target/release/bundle/nsis/
macOS:   target/release/bundle/dmg/ and target/release/bundle/macos/
Linux:   target/release/bundle/appimage/, target/release/bundle/deb/, and target/release/bundle/rpm/

Portable Zip

Build a portable Windows zip:

pnpm build:portable

The archive is written to:

target/release/bundle/portable/MochiPaw_<version>_windows_<arch>_portable.zip

Local Diagnostics

Windows installers and portable builds keep application-owned data in data beside the executable. Models, settings, startup logs, and WebView2 data use this directory. The application starts with fresh settings when it is absent; it does not read, copy, or remove the previous Roaming data.

See Windows data layout for the versioned format, directory permissions, and portable-folder behavior.

Windows startup diagnostics are local-only and are written to data/logs. If the application directory is not writable, startup reports a data-directory error instead of silently switching to a user-profile or temporary directory.

The directory contains startup-state.json, startup-events.jsonl, and the normal mochi-paw.log file. These files record startup phases and local error details without uploading anything.

Windows installers embed the WebView2 bootstrapper and verify a minimum runtime version during installation. The minimum is a floor rather than an exact version, so newer Evergreen runtimes (for example 151.0.4129.107) are accepted. Upgrades do not remove MochiPaw data or models. Portable builds cannot install system components; if WebView2 startup fails, run the Windows installer again to repair the runtime.

If a release executable already exists and you only want to recreate the zip:

node scripts/packagePortable.mjs --skip-build

Checks

pnpm lint
cargo check -p mochi-paw
cargo check -p tauri-plugin-admin-status

Release

GitHub Releases are the public release channel for MochiPaw builds.

pnpm release

The release script syncs package metadata through scripts/release.ts and uses release-it.

License

MochiPaw is a multi-license repository:

• BongoCat-derived material remains available under the MIT License.
• CatStack-authored additions are licensed under the PolyForm Noncommercial License 1.0.0 unless a file states otherwise.
• Third-party dependencies and bundled assets keep their own terms.

See LICENSE and NOTICE.md for the full license texts, attribution, and notices.

Attribution

MochiPaw is a derivative work of ayangweb/BongoCat, which was released under the MIT License.

The BongoCat MIT license text, attribution details, CatStack-authored additions, and license scope are documented in NOTICE.md.

Bundled Live2D/Cubism runtime files, model assets, images, icons, and other third-party material keep their original upstream terms. Review those terms before redistributing modified builds or using the assets outside this repository.