obsidian-plugin/bucknatt_mitsu-plugin
1
0
Fork 0
mirror of https://github.com/bucknatt/mitsu-plugin.git synced 2026-07-22 07:05:32 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
bucknatt_mitsu-plugin/README.md
bucknatt d098670157 prepare community release assets
2026-05-10 18:10:39 +02:00

1.3 KiB
Raw Blame History

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

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