Artyom is a Robust Wrapper of the Google Chrome SpeechSynthesis and SpeechRecognition that allows you to create a virtual assistent
npm install artyom.js
batch
npm install artyom.js
`
#### Bower
`batch
bower install artyom.js
`
Or just download a .zip package with the source code, minified file and commands examples : download .zip file
How to use
Artyom is totally written in TypeScript, but it's transpiled on every version to JavaScript. 2 files are built namely artyom.js (used with Bundlers like Webpack, Browserify etc.) and artyom.window.js (only for the web browser). As everyone seems to use a bundler nowadays, for the module loader used is CommonJS:
`javascript
// Using the /build/artyom.js file
import Artyom from './artyom.js';
const Jarvis = new Artyom();
Jarvis.say("Hello World !");
`
Alternatively, if you are of the old school and just want to use it with a script tag, you will need to use the artyom.window.js file instead:
`html
`
The source code of artyom handles a single TypeScript file /source/artyom.ts.
Basic usage
Writing code with artyom is very simple:
`javascript
// With ES6,TypeScript etc
import Artyom from './artyom.js';
// Create a variable that stores your instance
const artyom = new Artyom();
// Or if you are using it in the browser
// var artyom = new Artyom();// or new window.Artyom()
// Add command (Short code artisan way)
artyom.on(['Good morning','Good afternoon']).then((i) => {
switch (i) {
case 0:
artyom.say("Good morning, how are you?");
break;
case 1:
artyom.say("Good afternoon, how are you?");
break;
}
});
// Smart command (Short code artisan way), set the second parameter of .on to true
artyom.on(['Repeat after me *'] , true).then((i,wildcard) => {
artyom.say("You've said : " + wildcard);
});
// or add some commandsDemostrations in the normal way
artyom.addCommands([
{
indexes: ['Hello','Hi','is someone there'],
action: (i) => {
artyom.say("Hello, it's me");
}
},
{
indexes: ['Repeat after me *'],
smart:true,
action: (i,wildcard) => {
artyom.say("You've said : "+ wildcard);
}
},
// The smart commands support regular expressions
{
indexes: [/Good Morning/i],
smart:true,
action: (i,wildcard) => {
artyom.say("You've said : "+ wildcard);
}
},
{
indexes: ['shut down yourself'],
action: (i,wildcard) => {
artyom.fatality().then(() => {
console.log("Artyom succesfully stopped");
});
}
},
]);
// Start the commands !
artyom.initialize({
lang: "en-GB", // GreatBritain english
continuous: true, // Listen forever
soundex: true,// Use the soundex algorithm to increase accuracy
debug: true, // Show messages in the console
executionKeyword: "and do it now",
listen: true, // Start to listen commands !
// If providen, you can only trigger a command if you say its name
// e.g to trigger Good Morning, you need to say "Jarvis Good Morning"
name: "Jarvis"
}).then(() => {
console.log("Artyom has been succesfully initialized");
}).catch((err) => {
console.error("Artyom couldn't be initialized: ", err);
});
/**
* To speech text
*/
artyom.say("Hello, this is a demo text. The next text will be spoken in Spanish",{
onStart: () => {
console.log("Reading ...");
},
onEnd: () => {
console.log("No more text to talk");
// Force the language of a single speechSynthesis
artyom.say("Hola, esto está en Español", {
lang:"es-ES"
});
}
});
`
All you need to know about Artyom
- Documentation and FAQ
Do not hesitate to create a ticket on the issues area of the Github repository for any question, problem or inconvenient that you may have about artyom.
Development
Building Artyom from source
On every update, we build the latest version that can be retrieved from /build (for the browser and module). However, if you are willing to create your own version of Artyom, you would just need to modify the source file /source/artyom.ts and generate the build files using the following commands.
If you want to create the Browser version, you will need as first remove the export default keywords at the beginning of the class and run then the following command:
`bash
npm run build-artyom-window
`
If you want to create the Module version with CommonJS (for webpack, browserify etc) just run:
`bash
npm run build-artyom-module
`
Testing
If you're interested in modify, work with Artyom or you just simply want to test it quickly in your environment we recommend you to use the little Sandbox utility of Artyom. Using Webpack the Artyom Sandbox creates an HTTPS server accessible at https://localhost:3000, here artyom will be accesible in Continuous mode too.
Start by cloning the repository of artyom:
`bash
git clone https://github.com/sdkcarlos/artyom.js/
cd artyom.js
`
Switch to the sandbox directory:
`bash
cd sandbox
`
Then install the dependencies:
`bash
npm install
`
And start the Webpack dev server using:
`bash
npm start
``
| English (USA)
| Español | es-ES |
| Deutsch (German) | de-DE |
| Italiano |it-IT |
| Français |fr-FR |
| Japanese 日本人 | ja-JP |
| Russian | ru-RU |
| Brazil | pt-PT |
| Dutch (netherlands)| nl-NL |
| Polski (polonia)| pl-PL |
| Indonesian (Indonesia)| id-ID |
| Chinese (Cantonese[ 粤語(香港)]
| Hindi (India) | hi-IN |