mirror of
https://github.com/bucknatt/mitsu-plugin.git
synced 2026-07-22 07:05:32 +00:00
Drop launch helpers, internal reports, and outdated release doc; add CONTRIBUTING and generic RELEASE guide. Gitignore built main.js/styles.css; sanitize docs to use placeholder vault paths.
45 lines
1.4 KiB
Markdown
45 lines
1.4 KiB
Markdown
# Miku Hybrid
|
||
|
||
Hatsune Miku–inspired theme modes, optional dashboard widgets, and bundled hybrid styling for [Obsidian](https://obsidian.md/).
|
||
|
||
## Install
|
||
|
||
1. Open **Settings → Community plugins**.
|
||
2. Turn off **Restricted mode** (first-time setup).
|
||
3. Select **Browse**, search for **Miku** or **Hybrid**.
|
||
4. Install **Miku Hybrid**, then **Enable**.
|
||
|
||
No separate Appearance theme is required: releases bundle palette CSS into the plugin `styles.css`.
|
||
|
||
## Features
|
||
|
||
- Theme modes: `MinimalMiku`, `Concert`, `NightNeon`, `SnowMiku`
|
||
- Ribbon and command: **Cycle Miku theme mode**
|
||
- Optional status bar, banner, quote, and profile widgets
|
||
- Dashboard with original ASCII decoration presets
|
||
- Reduced-motion and glow intensity settings
|
||
|
||
## Commands
|
||
|
||
| Command | Action |
|
||
|---------|--------|
|
||
| Cycle Miku theme mode | Rotates the active `data-miku-theme` mode |
|
||
| Open Miku dashboard | Opens the Miku panel view |
|
||
|
||
## No-audio policy
|
||
|
||
This plugin includes no audio assets, APIs, or dependencies.
|
||
|
||
## Legal
|
||
|
||
- Fan-inspired visuals and original ASCII motifs only—not official Crypton Future Media artwork or audio.
|
||
- Do not redistribute official character media without permission.
|
||
- You are responsible for compliance with applicable trademark and copyright law.
|
||
|
||
## Development
|
||
|
||
See [CONTRIBUTING.md](CONTRIBUTING.md) for build, local vault install, and release steps.
|
||
|
||
## License
|
||
|
||
MIT — see [LICENSE](LICENSE).
|