Skip to content

Commit

Permalink
Update plugin name to alltalk-tts and version to 1.0.0
Browse files Browse the repository at this point in the history
- Changed plugin ID to alltalk-tts
- Updated version to 1.0.0 across all files
- Removed Obsidian from titles and descriptions
- Updated installation paths in documentation
  • Loading branch information
Mithadon committed Dec 2, 2024
1 parent 709a341 commit c6dbaec
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 14 deletions.
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Obsidian AllTalk TTS Plugin
# AllTalk TTS Plugin

This plugin integrates [AllTalk TTS](https://github.com/erew123/alltalk_tts/) with Obsidian, allowing you to use your local AllTalk TTS server to generate high-quality text-to-speech from your notes. It uses the XTTS-v2 engine, which can be fine-tuned to faithfully reproduce natural speech patterns. I also drew inspiration from the AllTalk-TTS implementation within [SillyTavern](https://github.com/SillyTavern/SillyTavern).
This plugin integrates [AllTalk TTS](https://github.com/erew123/alltalk_tts/) to generate high-quality text-to-speech from your notes. It uses the XTTS-v2 engine, which can be fine-tuned to faithfully reproduce natural speech patterns. I also drew inspiration from the AllTalk-TTS implementation within [SillyTavern](https://github.com/SillyTavern/SillyTavern).

Obsidian-AllTalk-TTS enables generation of highlighted text or entire notes at once, with optional audio streaming or .wav file concatenation and saving. It is also possible to automatically embed the saved audio files within the markdown text.
The plugin enables generation of highlighted text or entire notes at once, with optional audio streaming or .wav file concatenation and saving. It is also possible to automatically embed the saved audio files within the markdown text.

## Features

Expand Down Expand Up @@ -45,28 +45,28 @@ The plugin offers extensive configuration options:

### Required Files

For manual installation, you need these files in your `.obsidian/plugins/obsidian-alltalk-tts/` folder:
For manual installation, you need these files in your `.obsidian/plugins/alltalk-tts/` folder:

```
obsidian-alltalk-tts/
alltalk-tts/
├── main.js
├── manifest.json
└── styles.css
```

### From Obsidian Community Plugins (Not yet available)
### From Community Plugins (Not yet available)

1. Open Obsidian Settings
1. Open Settings
2. Go to Community Plugins and disable Safe Mode
3. Click Browse and search for "AllTalk TTS"
4. Install the plugin and enable it

### Manual Installation

1. Create a folder called `obsidian-alltalk-tts` in your vault's `.obsidian/plugins/` directory
1. Create a folder called `alltalk-tts` in your vault's `.obsidian/plugins/` directory
2. Download `main.js`, `manifest.json`, and `styles.css` from the latest release
3. Place both files in the `obsidian-alltalk-tts` folder you created
4. Reload Obsidian
3. Place both files in the `alltalk-tts` folder you created
4. Reload the app
5. Enable the plugin in Community Plugins settings

### Building from Source
Expand All @@ -76,7 +76,7 @@ If you want to build the plugin yourself:
1. Clone the repository
2. Run `npm install` to install dependencies
3. Run `npm run build` to compile the plugin
4. Copy `main.js`, `manifest.json`, and `styles.css` to your vault's `.obsidian/plugins/obsidian-alltalk-tts/` folder
4. Copy `main.js`, `manifest.json`, and `styles.css` to your vault's `.obsidian/plugins/alltalk-tts/` folder

## Usage

Expand Down
6 changes: 3 additions & 3 deletions manifest.json
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
{
"id": "obsidian-alltalk-tts",
"id": "alltalk-tts",
"name": "AllTalk TTS",
"version": "0.1",
"version": "1.0.0",
"minAppVersion": "0.15.0",
"description": "Text-to-speech plugin for Obsidian using local AllTalk TTS server",
"description": "Text-to-speech plugin integrates XTTSv2 engine using local AllTalk TTS server",
"author": "Mithadon",
"authorUrl": "https://github.com/mithadon",
"isDesktopOnly": true,
Expand Down

0 comments on commit c6dbaec

Please sign in to comment.