# retro-speech-maker
> Speech-like sounds to go with your text in your retro game
Latest version **1.1.5** (published 2024-08-11) · ISC license · 0 weekly downloads
## Install
```sh
npm install retro-speech-maker
pnpm add retro-speech-maker
yarn add retro-speech-maker
bun add retro-speech-maker
```
## Health
**Score 20/100 (F)** — status: abandoned.
Positive: esm support; no vulnerabilities.
Warnings: low downloads; no types.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 1.1.5 |
| Published | 2024-08-11 |
| First published | 2021-08-22 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 92.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Author | Tiago 'Dosaki' Correia |
| Maintainers | dosaki |
| Keywords | speech, retro, game |
## Links
- npm: https://www.npmjs.com/package/retro-speech-maker
- Repository: https://github.com/dosaki/retro-speech-maker
- Homepage: https://github.com/dosaki/retro-speech-maker#readme
- Issues: https://github.com/dosaki/retro-speech-maker/issues
- npm.io page: https://npm.io/package/retro-speech-maker
## Recent versions
- 1.1.5 (latest) — 2024-08-11
- 1.1.4 — 2021-09-06
- 1.1.3 — 2021-08-25
- 1.1.2 — 2021-08-23
- 1.1.1 — 2021-08-23
- 1.1.0 — 2021-08-23
- 1.0.0 — 2021-08-22
- 0.0.1 — 2021-08-22
## README
# Live demo
See https://retro-speech.dosaki.net/
# Usage
The basic usage is as below:
```javascript
RetroSpeech.speak(length, gender, wave, tone, volume);
```
Valid tones are:
* `calm` - slows the text a little;
* `question` - starts in a high frequency and ends with low -> high -> low frequency;
* `exclamation` - a bit faster and ends in a 'climbing' tone of frequencies;
* `normal` - no changes
You can also let the sentence itself generate the right tone:
```javascript
RetroSpeech.speakText(text, gender, wave, volume);
```
## As a module
```shell
npm install retro-speech-maker
```
```javascript
const { RetroSpeech } = require('retro-speech-maker');
// Generate speech with a tone
RetroSpeech.speak(10, "female", "sawtooth", "calm", 0.8);
// or let the sentence itself generate the tone via punctuation
RetroSpeech.speakText("Hello there! How are you?", "female", "sawtooth", 1);
```
## As a script library
```html
```
```javascript
// main.js
// Generate speech with a tone
RetroSpeech.speak(10, "female", "sawtooth", "calm", 0.8);
// or let the sentence itself generate the tone via punctuation
RetroSpeech.speakText("Hello there! How are you?", "female", "sawtooth", 1);
```
---
_Source: https://npm.io/package/retro-speech-maker · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._