retro-speech-maker
v1.1.5
Published
Speech-like sounds to go with your text in your retro game
Downloads
24
Readme
Live demo
See https://retro-speech.dosaki.net/
Usage
The basic usage is as below:
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:
RetroSpeech.speakText(text, gender, wave, volume);
As a module
npm install retro-speech-maker
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
<!-- index.html -->
<html>
<body>
<script src="retro-speech.min.js"></script>
<script src="main.js"></script>
</body>
</html>
// 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);