A socket client/server program that exposes a widget with alerts (such as gifts, followers …) for a specific user streaming on Tik Tok Live platform.
About The Project
This program allows you to show alerts for TikTok Live events on your streaming client such as OBS or StreamLABS. The program exposes an html page where alerts can show off.
This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.
This is an example of how to list things you need to use the software and how to install them.
npm install --global yarn
- Clone the repo
git clone https://github.com/Sl4yZ/tiktoklive-widget.git
- Install NPM packages
- Create a
.envfile at the project root (copy sample configuration in
# DEFINE YOUR LANGUAGE LOCALE CLIENT_LOCALE=en-US # DEFINE TIKTOK STREAM USERNAME TIKTOK_USERNAME=INSERT_HERE # DEFINE WIDGET URI WIDGET_URI=http://localhost # DEFINE SERVER PORT PORT=80 # DEFINE TOAST DURATION (IN MS) TOAST_DURATION=500
- Start the app
Work in progress…
- Gifts Alert
- Lottery Command
- Messages List
- Likes Alert
- Questions Alert
See the open issues for a full list of proposed features (and known issues).
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag “enhancement”. Don’t forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature)
- Commit your Changes (
git commit -m 'Add some AmazingFeature')
- Push to the Branch (
git push origin feature/AmazingFeature)
- Open a Pull Request
Distributed under the MIT License. See
LICENSE file for more information.
Project Link: https://github.com/Sl4yZ/tiktoklive-widget