TikTok Live Reader

• Saving extracted data into text files, created in the Documents\TikTok live folder.
• Tracking events: comments, new followers, gifts, likes, shares, visitors, and guest requests.
• An events file that can record multiple types of data simultaneously.
• Audio notifications for selected events, such as new comments, gifts, etc.
• Stream statistics: displays current viewers, total session visitors, total likes, new followers, and diamonds collected.
• Top Gifters leaderboard: ranks users from most active to least active based on diamonds sent.
• Top Likers leaderboard: ranks users based on their total likes during the stream.

• comments.txt - Records all comments detected during the live stream with timestamps.
• followers.txt - Registers all new users who followed the live creator during the current session.
• gifts.txt - Logs all received gifts, reporting the user, gift type, quantity, and timestamp.
• likes.txt - Shows who liked the stream, when, and how many times.
• requests.txt - Registers all join requests sent to the host.
• shares.txt - Records the users who shared the live stream along with the timestamp.
• stats.txt - Shows current viewers, new followers, total likes, session visitors, and total diamonds received.
• top gifts.txt - A leaderboard of users who sent gifts, ranked from most to least active.
• top likes.txt - A leaderboard of users ranked by their total likes.
• visitors.txt - Records all visitors who entered the stream during the current session with timestamps.
• events.txt - Positioned between comments and followers during keyboard navigation, this file logs various event types defined in the settings. The goal is to easily track comments, followers, gifts, likes, requests, shares or visitors in one place.

Settings

General

• Username - Enter the TikTok host's username without the @ symbol.
• Clear files on startup - Deletes the content of text files when the add-on starts.
• Clean usernames - This option removes unnecessary elements from usernames. Many TikTok users use emojis and Unicode symbols that impede screen readers. When enabled, names are stripped down to only letters, numbers, and punctuation.
• Connection retry count - Defines how many times the add-on should try to connect to the live stream.

Events

• Play sounds for the selected events - Plays a specific short sound (e.g., for a new comment or gift). This can be toggled with NVDA+Shift+Control+P.
• Volume - Adjusts notification sound levels.
• Learn sounds - Plays a description of the sounds so the users get used to the different audio cues.

Auto speak

How to use the add-on

• Control+Shift+Right Arrow - Next file (e.g., Comments, Events, Followers, etc.).
• Control+Shift+Left Arrow - Previous file.
• Control+Shift+Down Arrow - Next item in the current file (e.g., comment, like, share).
• Control+Shift+Up Arrow - Previous item.
• Control+Shift+Home - Select the first item in the current file.
• Control+Shift+End - Select the last item.
• NVDA+Shift+Control+V - Reports current viewers.
• NVDA+Shift+Control+S - Toggles Auto speak on or off.
• NVDA+Shift+Control+P - Toggles sounds on or off.
• NVDA+Shift+Control+R - Clears content of the text and temporary files.

Notes

• Opening settings temporarily disables auto-speak and sounds, but data logging continues in the background.
• If the username is changed in settings, the add-on attempts to connect to the new user after saving.
• When automatic file clearing on startup is disabled, files will still contain data from the last live stream. If you want to clear them at the beginning of the current session, press NVDA+Shift+Control+R.
• If manual clearing is disabled, the add-on remembers your last position in the files (e.g., line 45 in comments).

Limitations

• A full viewer list cannot be shown because the TikTokLive library does not report when a user leaves.
• Ranking by watch time is not possible for the same reason.
• Gift names are reported in English because they are too numerous and update too frequently for viable translation.
• Guest join requests are only registered if the user has interacted with the stream previously. This is because TikTok does not publicly broadcast the names of users who only request to join without other activity.

Changelog

Version 1.5

1. Stabilized the logic for loading and disabling the add-on.
2. Migrated to the NVDA addon template for improved automation and localization.
3. Stabilized the logging logic for likes, shares, and follows.
4. The Auto speak option is now respected from the add-on. Announcements start 10 seconds after a successful connection.
5. The Auto speak tab now dynamically hides event options unless the main function is enabled.
6. Fixed a bug where sounds and announcements would play immediately after restart of the add-on.
7. Added shortcut NVDA+Shift+Control+P to toggle sounds during an active session.
8. Added access keys (Alt + letter) for all settings.
9. Optimized the Audio volume slider logic. Its label is now Volume.
10. Settings are now saved dynamically. Background logging continues while the settings window is opened.
11. Automatic connection to the new user if it's changed in active session.
12. Added support for tracking guest join requests. They are saved in requests.txt file.
13. A new "Requests" option in settings and a corresponding sound notification for the event.
14. Added username field validation: must be at least two characters and can contain only Latin letters, numbers, dots and underscores.

Acknowledgements

• Thanks to MuhammadGagah for optimizing the loading logic in an isolated environment and for the Indonesian translation.
• Thanks to Bena Karkova for her great ideas, support, and faith in this project.

Final Clarifications