dsh-tts-chat-answer 0.4.0 → 0.4.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +40 -35
  2. package/package.json +1 -1
package/README.md CHANGED
@@ -3,6 +3,28 @@
3
3
  `dsh-tts-chat-answer` narrates every completed assistant answer from DeepSeek
4
4
  Harness and saves the audio locally for later playback and play from web UI.
5
5
 
6
+ ## Setup
7
+
8
+ Install the bundle into a profile and run the interactive setup:
9
+
10
+ ```bash
11
+ dsh plugin --profile web add dsh-tts-chat-answer
12
+ npx -p dsh-tts-chat-answer dsh-tts-chat-answer-setup
13
+ ```
14
+
15
+ From a checkout, run `node setup.mjs` instead. The prompt asks for the profile,
16
+ the voice, and the playback mode, then writes a managed `tts-chat-answer`
17
+ override into that profile's `cordis.patch.yml`. Restart the Host afterwards;
18
+ `~/.local/share/dsh-tts-chat-answer/.ready` appears once the plugin mounts.
19
+
20
+ The voice menu is a numbered selector: pick a preset or the custom row and type
21
+ any Edge voice id. The playback menu offers `inline` (in-page audio) or `native`
22
+ (system player with in-page fallback). Options: `--profile web` skips the
23
+ profile question, `--yes` accepts the defaults, and `--dry-run` prints the
24
+ generated YAML without writing. Re-running updates the block delimited by
25
+ `# >>> dsh-tts-chat-answer setup >>>` in place and saves a timestamped copy of
26
+ the previous patch file.
27
+
6
28
  ## Storage
7
29
 
8
30
  The plugin stores audio files in `~/.local/share/dsh-tts-chat-answer/`, grouped
@@ -155,44 +177,26 @@ cat ~/.local/share/dsh-tts-chat-answer/.ready
155
177
  Remove the bundle from `dsh.profile.bundles` (or set `enabled: false`) to
156
178
  disable it.
157
179
 
158
- ## Interactive setup
159
-
160
- `setup.mjs` prompts for the narration settings and writes a managed
161
- `tts-chat-answer` override into a profile's `cordis.patch.yml`. The voice
162
- prompt is a numbered selector; pick a listed voice or choose the custom row
163
- to type any Edge voice id. The playback prompt offers `inline` (in-page audio)
164
- or `native` (system app with in-page fallback):
165
-
166
- ```bash
167
- node setup.mjs # prompt, profile defaults to web
168
- node setup.mjs --profile web # skip the profile prompt
169
- node setup.mjs --profile web --yes
170
- node setup.mjs --dry-run # print the generated YAML, write nothing
171
- ```
180
+ ## Plugin market
172
181
 
173
- The block is delimited by `# >>> dsh-tts-chat-answer setup >>>` /
174
- `# <<< dsh-tts-chat-answer setup <<<`, so re-running the script updates it in
175
- place instead of appending duplicates. A timestamped backup of the previous
176
- patch file is created before each write. The script does not install the
177
- package; install it first with `dsh plugin add`, then run setup and restart the
178
- Host.
182
+ The package is published on npm as `dsh-tts-chat-answer` and declares
183
+ `dsh.bundle`, an `engines.dsh` range, an icon, an English locale, and its
184
+ repository/author metadata, so a DSH plugin index can list it.
179
185
 
180
- ## Plugin market
186
+ `site/index.json` is deployed by `.github/workflows/pages.yml` and served at
187
+ <https://vladimircores.github.io/dsh-tts-chat-answer/>. Add
188
+ `https://vladimircores.github.io/dsh-tts-chat-answer/index.json` under
189
+ **Plugins → Discover → Add index source**.
181
190
 
182
- The package declares `dsh.bundle`, an `engines.dsh` range, an icon, an English
183
- locale, and its repository/author metadata, so it can be listed by a DSH plugin
184
- index. A ready index lives at `site/index.json`; regenerate it after a release
185
- with the reference generator:
191
+ Regenerate the entry with the reference generator after a release:
186
192
 
187
193
  ```bash
188
194
  pnpm --filter @deepseek-ai/dsh-plugin-market-generator start \
189
195
  --input plugins.txt --output site/index.json --title "TTS Chat Answer"
190
196
  ```
191
197
 
192
- `plugins.txt` holds one line per source: the Git URL gives a commit-pinned
193
- entry, while `dsh-tts-chat-answer` gives an npm entry after the package is
194
- published. Serve the `site/` directory over HTTPS and add its `index.json` URL
195
- under **Plugins → Discover**. See the
198
+ `plugins.txt` holds one line per source: the npm name produces an npm entry; an
199
+ `https://` Git URL produces a commit-pinned entry instead. See the
196
200
  [plugin index guide](https://deepseek-harness.github.io/deepseek-harness/en/guide/plugin-market).
197
201
 
198
202
  ## Publish a release
@@ -215,14 +219,15 @@ path at publish time.
215
219
  Then publish and tag:
216
220
 
217
221
  ```bash
218
- npm publish # needs npm auth and the dsh-tts-chat-answer name
219
- git push origin main --tags
222
+ npm version patch # bumps package.json, commits, tags vX.Y.Z
223
+ npm publish
224
+ git push --follow-tags
220
225
  ```
221
226
 
222
- After the registry accepts the version, switch the market entry from the
223
- commit-pinned Git source to npm: set the version's `source` to
224
- `{"type": "npm"}` and `publishTimestamp` to the registry time, or replace the
225
- Git URL in `plugins.txt` with `dsh-tts-chat-answer` and regenerate the index.
227
+ After the registry accepts the version, update `site/index.json`: set
228
+ `version`, set `publishTimestamp` to the registry time (`npm view
229
+ dsh-tts-chat-answer time --json`), and keep `source` as `{"type": "npm"}`. The
230
+ Pages workflow republishes `site/` on the next push.
226
231
 
227
232
  ## Requirements
228
233
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "dsh-tts-chat-answer",
3
- "version": "0.4.0",
3
+ "version": "0.4.1",
4
4
  "description": "Narrate completed assistant answers with Edge TTS, save audio locally, and play it in-page or in a native MPRIS player.",
5
5
  "author": "Vladimir Cores",
6
6
  "license": "MIT",