README file from
GithubAccretion Disk 3D
Your vault as a 3D black hole: a black eye, a disk of golden particles, and a half-moon arc of your note names tied to the eye by curved lines with glowing beads.
The interface text (buttons and default list names) is currently in Brazilian Portuguese. See the table below for what each label means.
Demo
https://github.com/user-attachments/assets/1df0be7b-e47d-481c-a821-ef0c9c94f0da
Open it
Click the eye icon in the ribbon, or run the command Open Accretion Disk 3D (Cmd/Ctrl+P).
What you can do
- Switch lists: use the small arrows beside the title. Scroll or drag over the names to spin the wheel.
- Select a note: click (or press-and-hold / double-click, depending on settings). Click the active note to open a card with the start of its text.
- ABRIR NOTA (open note): opens the note in a tab.
- RENOMEAR NOTA (rename note): edit the note name right on the card (Enter saves, Esc cancels). Obsidian updates links that pointed to it if "Automatically update internal links" is on.
- CAMINHO ATÉ… (path to…): (or the command "Path between notes") type another note's name to see the shortest chain of links between the two, in a box with clickable steps and a golden line on the arc.
- Zoom through the rings: zoom in (mouse wheel, trackpad pinch, or the Zoom in / Zoom out commands). The arc names fade and two rings with the most-connected notes appear; very close, vault stats appear inside the eye. Zoom out to return to the lists.
- FOCO (focus), key F: hides the panels. RESET returns the view to the start.
- Drag on the eye to tilt it up, down and sideways.
Where the lists come from
- CLIENTES (clients): if any note has the tag
#cliente(or lives in aClientesfolder), only those appear. With no marking, notes whose title contains "ESTADO ATUAL" are used. - REGRAS (rules): title starting with "Regra"/"Regras", a
Regrasfolder, or tag#regra. - SKILLS: "skill" in the title, a
Skillsfolder, or tag#skill. - RECENTES (recent), MAIS LIGADAS (most linked), ÓRFÃS (orphans, no links) and PARADAS (stale, untouched for 30 days by default, configurable).
- One list for each top-level folder with 3 or more notes.
- Each list shows up to 150 notes. Notes created in the last 48 h glow brighter. Lines connect notes that really link to each other.
- The view refreshes itself a few seconds after the vault changes.
- You can edit or add your own lists in CONFIG ("Novo tópico").
Settings (CONFIG button)
| Option | What it does |
|---|---|
| Select an item by | Click, hold, or double-click |
| Brightness | Intensity of the gold |
| Soft lines (2nd layer) | How many thin lines per item |
| Quality | Automatic (adjusts to FPS), high, medium or low |
| Note "stale" after | 15, 30, 60 or 90 days untouched (PARADAS list) |
| Pause when idle | 5, 10, 30 minutes or never. Always pauses when the view is hidden |
| Random light pulse | A pulse about every 10 s |
| Golden meteor | A meteor passes now and then |
| Decorative terminal panel | "Typed" code in the left corner (visual only) |
| Soft sound | Gentle sounds on hover and click |
| Letters per name | Maximum name length on the arc |
| Highlight recent notes (48 h) | Toggles the glow on new notes |
| Neighborhood mode | Only the active note and its links stay highlighted |
Settings are saved in the plugin's data.json.
Privacy
Everything runs locally. The plugin reads note titles, links, tags and modification dates from your vault to build the view. It makes no network requests and sends no data anywhere.
Performance
The animation pauses when the view is hidden and, by default, after 5 minutes without mouse movement. Quality adjusts itself by FPS. Desktop only; weak graphics cards may need the low quality setting.
Development
npm install
npm run dev # watch build into the test vault
npm run build # production build in dist/
npm run harness # the scene without Obsidian, at http://127.0.0.1:5174
Requires Obsidian 1.5.0 or newer.
Credits and license
MIT license (see LICENSE). The 3D scene uses three.js, MIT licensed. All visuals are generated by code; no third-party images are included.