Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jstnmcbrd/dectalk-tts
API wrapper for the Dectalk TTS system
https://github.com/jstnmcbrd/dectalk-tts
api dectalk text-to-speech tts wav
Last synced: about 2 months ago
JSON representation
API wrapper for the Dectalk TTS system
- Host: GitHub
- URL: https://github.com/jstnmcbrd/dectalk-tts
- Owner: JstnMcBrd
- License: apache-2.0
- Created: 2024-02-12T11:53:01.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-10-28T08:28:03.000Z (2 months ago)
- Last Synced: 2024-10-28T10:20:28.620Z (2 months ago)
- Topics: api, dectalk, text-to-speech, tts, wav
- Language: TypeScript
- Homepage: https://npmjs.com/package/dectalk-tts
- Size: 437 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# dectalk-tts
[](https://github.com/JstnMcBrd/dectalk-tts/actions/workflows/api.yml)
[](https://github.com/JstnMcBrd/dectalk-tts/actions/workflows/validate.yml)
[](https://www.npmjs.com/package/dectalk-tts)
[](./LICENSE)
## About
**dectalk-tts** is a simple [Node](https://nodejs.org/) package to interact with the **aeiou** Dectalk web API. It is developed in [TypeScript](https://www.typescriptlang.org/) and transpiles to JavaScript (ESM).
[Dectalk](https://github.com/dectalk/dectalk) is a text-to-speech engine originally created in the 1980s. Today, it is best known for [viral videos](https://www.youtube.com/watch?v=Hv6RbEOlqRo) of the game [Moonbase Alpha](https://store.steampowered.com/app/39000/Moonbase_Alpha/).
[aeiou](https://github.com/calzoneman/aeiou) is a third-party web API that makes interacting with Dectalk much easier.
> 
>
> This package sends all input to a third-party API, which could be a possible privacy concern!
> By using this package, you acknowledge and agree to not hold the author of this package liable for how the third party uses your data.
>
> Please read the [usage guidelines](https://github.com/calzoneman/aeiou/blob/master/docs/usage-guidelines.md) of the API.
## Prerequesites
This package has no production dependencies!
However, it does require Node 18 or higher. Use `node --version` to check your node version.
## Installation
`npm install dectalk-tts`
## Usage
If the API returns a non-200 response, an error will be thrown.
None of the examples below include error handling, but don't forget it!
### ES Modules
```js
import dectalk from 'dectalk-tts';
import { writeFileSync } from 'node:fs';
const output = await dectalk('aeiou');
writeFileSync('output.wav', output);
```
### CommonJS
```js
const dectalk = require('dectalk-tts');
const { writeFileSync } = require('node:fs');
(async () => {
const output = await dectalk('John Madden');
writeFileSync('output.wav', output);
})();
// or
dectalk('uuuuuuuuuu').then((output) => writeFileSync('output.wav', output));
```
### Options
Please see Chapter 2 of the [Dectalk guide PDF](docs/dtk_reference_guide.pdf) for details on how to customize your requests. You can choose different voices, have Dectalk sing, and more!
None of these options are hard-coded into this package, so you must format the request string yourself.
(The Dectalk guide PDF was copied from the Dectalk 4.61 release download, which can be found [here](https://web.archive.org/web/20240226085720/https://theflameofhope.co/dectalkreader1/).)
## Development
When a merge request is created, the changes must pass linting, building, and unit tests. These checks are run automatically by GitHub. You can run them manually using `npm run lint`, `npm run build`, and `npm test`.
GitHub will also periodically run a test to confirm the API is still working. You can run this test manually with `npm run test-api`.
When a new [Release](https://github.com/JstnMcBrd/dectalk-tts/releases) is created, GitHub will automatically deploy the new version to the [npm registry](https://npmjs.com/package/dectalk-tts).
This project abides by [Semantic Versioning](https://semver.org/) and [Keep A Changelog](https://keepachangelog.com/). To see a list of changes for each update, check the description of [releases on GitHub](https://github.com/JstnMcBrd/dectalk-tts/releases).