63 lines
No EOL
2.6 KiB
Markdown
63 lines
No EOL
2.6 KiB
Markdown
# LoquendoBot
|
|
A loquendo bot made by wannabe developers
|
|
|
|
<a href="https://imgur.com/562WiO7"><img src="https://i.imgur.com/562WiO7.png" title="source: imgur.com" /></a>
|
|
|
|
## About
|
|
This bot is a electron app purely made of:
|
|
* HTML (Frontend)
|
|
* CSS (Frontend)
|
|
* Javascript (Frontend)
|
|
* Python (Backend)
|
|
* SQLite (Database)
|
|
|
|
All communication of the backend to frontend is made with JSON using [py-shell](https://www.npmjs.com/package/python-shell)
|
|
it is meant to be a simple bot, nothing overly complex and more importantly FREE!
|
|
## What you need before running the program
|
|
### Twitch:
|
|
* Client id: from [here](https://dev.twitch.tv/) place it in the settings.ini file under TWITCH > CLIENT_ID
|
|
* Client secret: from [here](https://dev.twitch.tv/) place it in the settings.ini file under TWITCH > CLIENT_SECRET
|
|
* OAuth token: from [here](https://twitchapps.com/tmi/) place it in the settings.ini file under TWITCH > OAUTH_TOKEN
|
|
* Channel name: place it in the settings.ini file under TWITCH > CHANNEL_NAME
|
|
* Username: place it in the settings.ini file under TWITCH > USERNAME
|
|
|
|
## To run the program (as a user)
|
|
* Run installer or portable mode
|
|
* Enter either your channel info in
|
|
|
|
## For developers (if you want to develop for it or expand its functionality)
|
|
|
|
* [Optional] Run as administrator
|
|
* [Required] have [nodejs](https://nodejs.org/en/) installed
|
|
### To run as a developer
|
|
1. run command: npm install
|
|
2. run command: pip install
|
|
3. npm start (to start the program)
|
|
### Recommendations
|
|
* We use vscode with the following extensions:
|
|
* SQLite
|
|
* JavaScript Debugger
|
|
* NPM
|
|
* NPM Intellisense
|
|
* HTML CSS Support
|
|
* Todo Tree, i recommend [this guide](https://thomasventurini.com/articles/the-best-way-to-work-with-todos-in-vscode/)
|
|
* To build you need to globally install electron and electron-packager:
|
|
* npm i -g electron
|
|
* npm i -g electron-packager
|
|
* to actually build the program run: electron-packager
|
|
|
|
## Where to get voices
|
|
### Available online voices that are in the bot
|
|
* [amazon voices](https://docs.aws.amazon.com/polly/latest/dg/voicelist.html)
|
|
* [google voices](https://github.com/IldarSham/node-google-tts-api/blob/master/supported-languages.txt)
|
|
### Windows
|
|
* [Speech2Go](https://harposoftware.com/en/spanish-spain-/340-S2G-Jorge-Nuance-Voice.html).
|
|
### Linux
|
|
* WIP
|
|
### Mac
|
|
* WIP
|
|
## Custom node_modules
|
|
* Say.js: changes come from here [Marak/Say.js](https://github.com/Marak/say.js) this will make it possible to send encoding which serves for pronunciation of words better.
|
|
|
|
## Encoding options for better pronunciations (depends on the TTS language)
|
|
* [iconv-lite](https://github.com/ashtuchkin/iconv-lite/wiki/Supported-Encodings) |