No description
Find a file
2026-05-15 15:04:22 +02:00
obsidian-miku-plugin optimize install to vault docs 2026-05-15 15:04:22 +02:00
obsidian-miku-theme add contributor 2026-05-15 14:47:26 +02:00
qa optimize install to vault docs 2026-05-15 15:04:22 +02:00
.gitignore prepare community release assets 2026-05-10 18:10:39 +02:00
package-lock.json initial commit 2026-04-28 20:44:44 +02:00
README.md optimize install to vault docs 2026-05-15 15:04:22 +02:00

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.js
  • obsidian-miku-plugin/styles.css
  • obsidian-miku-plugin/manifest.json

Theme package

  • obsidian-miku-theme/theme.css
  • obsidian-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
  • 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