Changes:

`TikTokEventListener` new method of listening events see it at TestApplication/ListenerExample.java Bugs: - Fixed bug: Websocket was sending ping after it was closed
2026-02-28 17:29:39 -05:00 · 2023-09-07 03:19:25 +02:00
parent 911e2b12a5
commit 4a157143ec
99 changed files with 2558 additions and 762 deletions
--- a/Tools-ReadmeGenerator/src/main/resources/template.md
+++ b/Tools-ReadmeGenerator/src/main/resources/template.md
@@ -0,0 +1,89 @@
+[![](https://jitpack.io/v/jwdeveloper/TikTok-Live-Java.svg)](https://jitpack.io/#jwdeveloper/TikTok-Live-Java)
+
+
+# TikTokLive Java
+A Java library based on [TikTokLive](https://github.com/isaackogan/TikTokLive) and [TikTokLiveSharp](https://github.com/sebheron/TikTokLiveSharp). Use it to receive live stream events such as comments and gifts in realtime from [TikTok LIVE](https://www.tiktok.com/live) by connecting to TikTok's internal WebCast push service. The package includes a wrapper that connects to the WebCast service using just the username (`uniqueId`). This allows you to connect to your own live chat as well as the live chat of other streamers. No credentials are required. Besides [Chat Comments](#chat), other events such as [Members Joining](#member), [Gifts](#gift), [Subscriptions](#subscribe), [Viewers](#roomuser), [Follows](#social), [Shares](#social), [Questions](#questionnew), [Likes](#like) and [Battles](#linkmicbattle) can be tracked. You can also send [automatic messages](#send-chat-messages) into the chat by providing your Session ID.
+
+Join the support [discord](https://discord.gg/e2XwPNTBBr) and visit the `#java-support` channel for questions, contributions and ideas. Feel free to make pull requests with missing/new features, fixes, etc
+
+Do you prefer other programming languages?
+- **Node** orginal: [TikTok-Live-Connector](https://github.com/isaackogan/TikTok-Live-Connector) by [@zerodytrash](https://github.com/zerodytrash)
+- **Python** rewrite: [TikTokLive](https://github.com/isaackogan/TikTokLive) by [@isaackogan](https://github.com/isaackogan)
+- **Go** rewrite: [GoTikTokLive](https://github.com/Davincible/gotiktoklive) by [@Davincible](https://github.com/Davincible)
+- **C#** rewrite: [TikTokLiveSharp](https://github.com/frankvHoof93/TikTokLiveSharp) by [@frankvHoof93](https://github.com/frankvHoof93)
+
+**NOTE:** This is not an official API. It's a reverse engineering project.
+
+#### Overview
+- [Getting started](#getting-started)
+- [Configuration](#configuration)
+- [Methods](#methods)
+- [Events](#events)
+- [Contributing](#contributing)
+
+## Getting started
+
+1. Install the package via Maven
+
+```xml
+   <repositories>
+        <repository>
+            <id>jitpack.io</id>
+            <url>https://jitpack.io</url>
+        </repository>
+    </repositories>
+
+   <dependencies>
+         <dependency>
+            <groupId>com.github.jwdeveloper.TikTok-Live-Java</groupId>
+            <artifactId>Client</artifactId>
+            <version>{{version}}</version>
+            <scope>compile</scope>
+        </dependency>
+        <dependency>
+            <groupId>com.google.code.gson</groupId>
+            <artifactId>gson</artifactId>
+            <version>2.10.1</version>
+        </dependency>
+   </dependencies>
+```
+
+2. Create your first chat connection
+
+```java
+{{Code-Example}}
+```
+## Configuration
+
+```java
+{{Configuration-Example}}
+```
+## Listener Example
+
+```java
+{{Listener-Example}}
+```
+
+## Methods
+A `client (LiveClient)` object contains the following methods.
+
+{{methods}}
+
+| Method Name         | Description |
+|---------------------| ----------- |
+| connect             | Connects to the live stream. |
+| disconnect          | Disconnects the connection. |
+| getGiftManager      |  Gets the meta informations about all gifts. |
+| getRoomInfo         | Gets the current room info from TikTok API including streamer info, room status and statistics. |
+| getListenersManager | Gets and manage TikTokEventListeners    |
+
+## Events
+
+A `TikTokLive` object has the following events
+
+{{Events}}
+
+<br><br>
+
+## Contributing
+Your improvements are welcome! Feel free to open an <a href="https://github.com/jwdeveloper/TikTok-Live-Java/issues">issue</a> or <a href="https://github.com/jwdeveloper/TikTok-Live-Java/pulls">pull request</a>.