Skip to content

Latest commit

 

History

History
67 lines (54 loc) · 3.89 KB

README.md

File metadata and controls

67 lines (54 loc) · 3.89 KB
Raw

TikTok-Chat-Reader

A chat reader for TikTok LIVE utilizing TikTok-Live-Connector and Socket.IO to forward the data to the client. This demo project uses the unofficial TikTok API to retrieve chat comments, gifts and other events from TikTok LIVE.

Easy Installation, no host needed!

Tip

I recently found out about IDX.Google.com which can host this package for free, for personal usage.

  1. Fork this repo to your account.
  2. Go to IDX.Google.com - You'll probably have to sign in or connect your github account.
  3. Open your forked project within the IDX Editor
  4. It will auto launch the on the side like VSCode's built in previewer.

Original Demo: https://tiktok-chat-reader.zerody.one/

^ That demo does not have the changes I've made. Please use the solution above using idx.google.com to see this repo's capabilities.

Installation

To run the chat reader locally, follow these steps:

  1. Install Node.js on your system
  2. Clone this repository or download and extract this ZIP file
  3. Open a console/terminal in the root directory of the project
  4. Enter npm i to install all required dependencies
  5. Enter node server.js to start the application server

Now you should see the following message: Server running! Please visit http://localhost:8091
Simply open http://localhost:8091/ in your browser. Thats it.

If you have problems with Node.js, you can also just open the index.html from the public folder.
This will use the server backend of the demo site, which is sufficient for testing purposes. If you want to offer it to others or make many connections at the same time, please consider using your own server.

Note

I recently found out about IDX.Google.com and you're able to fork this repo then open this repo within Google's IDX editor and see this working on the side without needing to download, and without the need for a host, for personal usage.

Yohn's Updates

  • Separated everything away from the chat
    • Likes (number is not correct
    • New followers
    • Shares
    • When users under gifter level 25 join
  • TTS - Text to Speech for comments (can be disabled)
  • Different sounds for gifts (can be disabled)
    • Best way to add / edit sounds is to add them to the config file
  • A way to save gifts sent in live to a google spreadsheet.
  • Gifter badges
  • Team Member badges
  • Subscriber icon
  • Moderator icon
  • Battle scores, even for 2v2
    • Sometimes the battle scores come back to the wrong hosts. This is because of how its received from the TikTok-Live-Connector
  • Battle timer
  • Sometimes the times off by a second, possibly more if the time booster was used
  • If the gift is sent to someone in the guest boxes it will note that in the box area
    • If the receiver was not tapping, commenting or sending gifts since connecting the receiver will be blank.
  • Names entered to connect to the persons live are saved within the config file (works automatically)
  • Notes can be saved into the config file, or within the cog menu
  • Host info
  • Top 3 gifters before connecting to the live

Screenshot

Screenshot 1 image