LoquendoBot/readme.md
2024-10-13 22:37:36 +02:00

50 lines
2.4 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 made of:
* HTML (Frontend)
* CSS (Frontend)
* Javascript (Frontend)
* SQLite (Backend / Database)
## Functionalit
* Multilingual
* Sound notifications
* Custom Theme, make your own theme (not everybody likes purple ;D )
* Text to speech to read chat messages, you can use your installed TTS, Google TTS or Amazon Polly.
* Speak to text to speak into the chat or speak as a TTS voice (WIP)
* PNGTuber functionality, also usable in OBS as browsersource (WIP)
* Custom chatbubble functionality, also usable in OBS as browsersource (WIP)
## What you need before running the program
### Twitch:
You need to obtain your own credentials to use this bot.
* 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
After getting your credentials you can set it in <img src="https://raw.githubusercontent.com/FortAwesome/Font-Awesome/6.x/svgs/solid/gears.svg" width="25" height="25"> > Show Advanced > <img src="https://raw.githubusercontent.com/FortAwesome/Font-Awesome/6.x/svgs/brands/twitch.svg" width="25" height="25">
### Amazon Polly:
* WIP
After getting your credentials you can set it in <img src="https://raw.githubusercontent.com/FortAwesome/Font-Awesome/6.x/svgs/solid/gears.svg" width="25" height="25"> > Show Advanced > <img src="https://raw.githubusercontent.com/FortAwesome/Font-Awesome/6.x/svgs/brands/amazon.svg" width="25" height="25">
### Google TTS:
* WIP
After getting your credentials you can set it in <img src="https://raw.githubusercontent.com/FortAwesome/Font-Awesome/6.x/svgs/solid/gears.svg" width="25" height="25"> > Show Advanced > <img src="https://raw.githubusercontent.com/FortAwesome/Font-Awesome/6.x/svgs/brands/google.svg" width="25" height="25">
## Where to get voices
### Windows
* [Speech2Go](https://harposoftware.com/en/spanish-spain-/340-S2G-Jorge-Nuance-Voice.html).
### Linux
* WIP
### Mac
* WIP