README file from
GithubVaultCast
VaultCast is a cute private podcast player for local audio files in your Obsidian vault.
It is designed for people who generate, download, or sync audio into their vault and want one simple player instead of opening audio files one by one.
Features
- Scan a vault folder for local audio files
- Play audio inside Obsidian
- Play, pause, previous, and next controls
- Seek with a full-width progress bar
- Volume and playback speed controls
- Playback modes: sequential, playlist loop, single loop, and shuffle
- Searchable playlist
- Sort by name, created time, or modified time
- Resume from the last saved position
- Mark tracks as completed after listening
- Recent plays list
- Seasonal themes: Default, Spring, Summer, Autumn, and Winter
- Open same-name Markdown notes for audio files
- Mobile-friendly main-area player command
Supported audio formats:
.mp3.m4a.wav.flac.aac
Installation
From Obsidian Community Plugins
VaultCast is not yet listed in the official Community Plugins directory.
Manual Installation
Download these files from the latest GitHub release:
manifest.jsonmain.jsstyles.css
Place them in:
<your-vault>/.obsidian/plugins/vaultcast/
Then restart Obsidian and enable VaultCast from:
Settings -> Community plugins -> Installed plugins
Usage
-
Put audio files in a folder inside your vault, for example:
Audio/ -
Open:
Settings -> VaultCast -
Set Audio folder to the vault-relative folder path.
-
Run the command:
Open VaultCast player -
Press Play latest or choose a track from the playlist.
Audio Folder Paths
VaultCast uses vault-relative paths.
For example, if your full folder path is:
/Users/you/Documents/My Vault/TTS Audio
and your vault root is:
/Users/you/Documents/My Vault
then set the VaultCast audio folder to:
TTS Audio
Do not enter the full computer path.
More examples:
Audio
Daily Audio
Podcasts/TTS
Assets/Audio
Mobile
On mobile, use the command:
Open VaultCast player
VaultCast will open in the main workspace area so it feels more like a full-page player.
There is also a desktop-friendly command:
Open VaultCast player in main area
Settings
- Audio folder: folder to scan for audio files
- Choose audio folder: pick from folders in the current vault
- Default speed: default playback speed
- Auto resume: continue from saved position
- Auto scan: refresh when files change
- Sort method: name, created time, or modified time
- Sort direction: ascending or descending
- Playback mode: loop, sequential, single loop, or shuffle
- Theme: seasonal visual theme
- Recent plays limit: number of recent tracks to keep
Development
Install dependencies:
npm install
Build:
npm run build
Development watch mode:
npm run dev
Roadmap
- Better mobile layout refinements
- Optional custom cover image
- Per-track cover matching
- Folder-specific playlists
- Keyboard shortcuts
License
MIT