mozilong
/
obsidian-TTS
0
0
Fork 1
Code Issues Pull Requests Actions Packages Projects Releases 1 Wiki Activity
6 Commits 2 Branches 1 Tag 117 KiB
TypeScript 91.1%
CSS 6.9%
JavaScript 2%
Go to file
mozilong ea5f56f055 docs(fix): fix Chinese or English link 2026-04-03 23:06:24 +08:00
src Initial commit: Obsidian TTS plugin with MiniMax and Xiaomi engines 2026-04-03 22:46:38 +08:00
.editorconfig Initial commit: Obsidian TTS plugin with MiniMax and Xiaomi engines 2026-04-03 22:46:38 +08:00
.gitignore Initial commit: Obsidian TTS plugin with MiniMax and Xiaomi engines 2026-04-03 22:46:38 +08:00
.npmrc Initial commit: Obsidian TTS plugin with MiniMax and Xiaomi engines 2026-04-03 22:46:38 +08:00
LICENSE Initial commit: Obsidian TTS plugin with MiniMax and Xiaomi engines 2026-04-03 22:46:38 +08:00
README.md docs(fix): fix Chinese or English link 2026-04-03 23:06:24 +08:00
README_EN.md docs(fix): fix Chinese or English link 2026-04-03 23:06:24 +08:00
esbuild.config.mjs Initial commit: Obsidian TTS plugin with MiniMax and Xiaomi engines 2026-04-03 22:46:38 +08:00
eslint.config.mts Initial commit: Obsidian TTS plugin with MiniMax and Xiaomi engines 2026-04-03 22:46:38 +08:00
manifest.json Initial commit: Obsidian TTS plugin with MiniMax and Xiaomi engines 2026-04-03 22:46:38 +08:00
package-lock.json Initial commit: Obsidian TTS plugin with MiniMax and Xiaomi engines 2026-04-03 22:46:38 +08:00
package.json Initial commit: Obsidian TTS plugin with MiniMax and Xiaomi engines 2026-04-03 22:46:38 +08:00
styles.css Initial commit: Obsidian TTS plugin with MiniMax and Xiaomi engines 2026-04-03 22:46:38 +08:00
tsconfig.json Initial commit: Obsidian TTS plugin with MiniMax and Xiaomi engines 2026-04-03 22:46:38 +08:00
version-bump.mjs Initial commit: Obsidian TTS plugin with MiniMax and Xiaomi engines 2026-04-03 22:46:38 +08:00
versions.json Initial commit: Obsidian TTS plugin with MiniMax and Xiaomi engines 2026-04-03 22:46:38 +08:00

README_EN.md

Obsidian TTS

中文|English Convert Obsidian note content to speech with MiniMax and Xiaomi MiMo TTS engines.

Features

TTS Engines

Engine Models Voices Special Features
MiniMax speech-2.8-hd / 2.8-turbo / 2.6-hd / 2.6-turbo 10 preset voices + custom cloned voices Emotion control (9 types), pitch, volume
Xiaomi MiMo mimo-v2-tts 3 preset voices Style control (dialects, emotions — 10 styles)

Playback Controls

  • Read selected text / read entire document
  • Play, pause, stop, seek
  • Draggable floating player with progress bar and time display
  • Status bar quick-access button
  • Automatic segmentation for long texts

Audio Export

  • Export as MP3 files saved to vault
  • Insert ![[audio.mp3]] embeds directly into notes
  • Custom export directory and filename format (supports noteName, timestamp variables)

Text Processing

  • Automatically skips code blocks, LaTeX formulas, HTML tags
  • Markdown markup cleanup
  • Smart segmentation (by paragraph, sentence, character count)

MiniMax Voice Cloning

  • Upload a 10-second to 5-minute audio file to clone a voice
  • Cloned voices appear automatically in the voice selector
  • Support for deleting cloned voices

Context Menu

Right-click in the editor for quick access to:

  • TTS: Read Selected Text
  • TTS: Read Entire Document
  • TTS: Insert Audio into Note

Installation

  1. Enable community plugins in Obsidian settings
  2. Search for Obsidian TTS and install
  3. Or manually: copy main.js, manifest.json, and styles.css to .obsidian/plugins/obsidian-tts-plugin/

Configuration

MiniMax

  1. Get an API Key from the MiniMax Platform
  2. Enter the API Key in plugin settings
  3. Select model, voice, speed, and other parameters

Xiaomi MiMo

  1. Get an API key from the Xiaomi MIMO
  2. Select "Xiaomi TTS" as the engine in plugin settings
  3. Enter the API Key and Base URL
  4. Select voice and style

Commands

Available via the command palette (Ctrl/Cmd + P):

Command Description
Read Selected Text Read currently selected text
Read Entire Document Read the full note content
Play / Pause Toggle playback
Stop Stop current playback
Toggle Floating Player Show/hide the player panel
Export Audio Generate audio and save to vault
Insert Audio into Note Generate audio and insert embed into note