mirror of
https://github.com/bucknatt/mitsu-plugin.git
synced 2026-07-22 07:05:32 +00:00
No description
| obsidian-miku-plugin | ||
| obsidian-miku-theme | ||
| qa | ||
| .gitignore | ||
| package-lock.json | ||
| README.md | ||
Obsidian Hatsune Miku Hybrid
This repository contains a hybrid split implementation:
obsidian-miku-plugin/: runtime plugin (theme switching, widgets, dashboard)obsidian-miku-theme/: visual theme package (palette, typography, components, animations)
Scope
- Full visual Hatsune Miku inspired experience
- Optional widget modules and dashboard tools
- Strict no-audio policy for legal/performance clarity
Release Artifacts
Plugin package
obsidian-miku-plugin/main.jsobsidian-miku-plugin/styles.cssobsidian-miku-plugin/manifest.json
Theme package
obsidian-miku-theme/theme.cssobsidian-miku-theme/manifest.json
Development
npm install --prefix ./obsidian-miku-plugin
npm run build --prefix ./obsidian-miku-plugin
npm run typecheck --prefix ./obsidian-miku-plugin
Manual testing (install into a vault)
Run QA scripts from the repository root (not from inside qa/):
cd /home/cachy/IdeaProjects/cachy/mitsu-plugin/obsidian-miku-plugin && npm run build
cd /home/cachy/IdeaProjects/cachy/mitsu-plugin
./qa/install-to-vault.sh /home/cachy/Documents/bfh4
Then enable Miku Plugin Hybrid and the Miku Theme Hybrid Base appearance theme in Obsidian. See qa/test-environment.md for launch helpers, vault registration, and troubleshooting.
Performance and Guardrails
- Event-driven UI updates only (no constant DOM polling)
- Widget lifecycle is mount/update/unmount based
- Reduced-motion mode is supported
- Avoid copyrighted official audio or proprietary assets
Legal Safety Notes
- Use inspired palettes and original assets
- Do not redistribute official Crypton media without permission
- Keep bundled artwork/iconography either original or licensed
- ASCII decorations in the plugin are repo-original text motifs, not official character artwork