Vault Aquarium / ヴォルト水槽

Vault Aquarium adds one gently swimming betta fish to Obsidian. Its body, fins, and pattern colors reflect the color-group structure of your vault, turning changes in your notes and links into a slowly evolving appearance.

Features

• Shows one animated betta fish over the Obsidian workspace.
• Uses the leading graph color groups for the fish body, fins, and patterns.
• Smoothly interpolates appearance changes instead of switching colors immediately.
• Opens a status and hide menu where you click, and lets you drag the fish anywhere.
• Saves local monthly growth records with note, link, and color-group statistics.
• Provides Japanese settings for size, speed, opacity, visibility, and graph rules.
• Lets you exclude a rule from the fish while keeping it in the graph view, so a folder holding most of your vault cannot monopolise the two colors the fish uses.
• Stops the render loop and the periodic saves while the fish is hidden, and honours prefers-reduced-motion by holding the fish still.

Privacy

Vault Aquarium does not analyze the meaning of note contents and does not send vault data to external services. Settings and growth records stay in the vault as Obsidian plugin data.

Usage and limitations

Enable the plugin, then open Settings → Vault Aquarium. The plugin attempts to read graph color groups from .obsidian/graph.json. Because Obsidian does not currently expose graph color groups through a stable public API, compatible manual rules such as path:Development and tag:#TRPG are also supported.

Manual installation

Download main.js, manifest.json, and styles.css from the latest GitHub release and place them in:

<vault>/.obsidian/plugins/vault-aquarium/

Restart Obsidian, then enable Vault Aquarium under Community plugins.

日本語

Vault Aquariumは、ヴォルトの色グループ構成を一匹のベタの姿に反映するObsidianプラグインです。魚は画面上をゆっくり泳ぎ、ノートやリンクの変化に合わせて体色・ヒレ色・模様が少しずつ変化します。

• 魚をクリックすると、その場でステータス・非表示メニューが開きます。
• ドラッグで好きな位置へ移動できます。
• ノート本文の意味解析や外部送信は行いません。
• グラフ色グループを公開APIから直接取得できないため、.obsidian/graph.jsonの読み取りと手動ルールを併用します。
• ルールごとに「魚から除外」を設定できます。グラフの色分けは残したまま、魚の統計からだけ外れます。ヴォルトの大半を占めるフォルダが上位2色を占領してしまうときに使ってください。
• 魚を隠している間は描画ループと定期保存が止まります。prefers-reduced-motion が有効な環境では、ヒレも遊泳も停止します。

Development

pnpm install
pnpm run typecheck
pnpm run build

The release main.js embeds the fish PNG assets as data URLs.

Author and license

Ogyanuntius XIII · MIT License