You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+81-88
Original file line number
Diff line number
Diff line change
@@ -6,9 +6,15 @@
6
6
7
7
</div>
8
8
9
-
<palign="center">TikTokLiveMCBE is a simple tool that connects your TikTok Live stream with your Minecraft.</p>
9
+
<palign="center">TikTokLiveMCBE is a simple tool that connects your TikTok Live stream with your Minecraft BE/PE.</p>
10
10
11
-
## Setup Tutorial on Termux
11
+
## Installation
12
+
13
+
### Prerequisites
14
+
15
+
Before you begin, ensure you have [Node.js](https://nodejs.org/) installed on your computer. If you're on an Android device, you can use Termux to run TikTokLiveMCBE.
16
+
17
+
#### Setup Tutorial on Termux
12
18
13
19
Click the image below to watch the full setup tutorial on YouTube!
14
20
@@ -18,33 +24,27 @@ Click the image below to watch the full setup tutorial on YouTube!
18
24
19
25
</div>
20
26
21
-
## Installation
22
-
23
-
### Prerequisites
24
-
25
-
Before you begin, ensure you have Node.js installed. If you're on a mobile device, you can use Termux to run this WebSocket server.
- Once the download is complete, extract the contents of the ZIP file to a folder of your choice.
38
38
39
-
- Once the download is complete, uncompress the ZIP file.
39
+
3.**Navigate to the TikTokLiveMCBE Folder**
40
40
41
-
3. Navigate to the Project Directory
41
+
- Using your terminal or command prompt, navigate to the extracted folder. For example:
42
42
43
43
```bash
44
44
cd TikTokLiveMCBE
45
45
```
46
46
47
-
4. Install the Dependencies
47
+
4.**Install the Dependencies**
48
48
49
49
```bash
50
50
npm install
@@ -60,18 +60,7 @@ Then install the dependencies:
60
60
yarn install
61
61
```
62
62
63
-
5. Set Up Configuration
64
-
65
-
Create an `.env` file in the root directory
66
-
67
-
```bash
68
-
TIKTOK_USERNAME=tiktok_username
69
-
PORT=3000 # or any other port you want to use
70
-
```
71
-
72
-
> **Note:** The TIKTOK_USERNAME should be the username of the TikTok account you want to connect to.
73
-
74
-
6. Start the Server
63
+
5.**Start the Server**
75
64
76
65
Start the TikTokLiveMCBE server:
77
66
```bash
@@ -82,23 +71,44 @@ or if you're using Yarn:
82
71
yarn start
83
72
```
84
73
85
-
> When you start the TikTokLiveMCBE server, it will attempt to connect to the TikTok live stream associated with the username specified in the .env file.
74
+
TikTokLiveMCBE will prompt you to provide your TikTok username, port number (default is `3000`), and select your desired plugins from the available options.
86
75
87
-
7. Connect Minecraft to Server
76
+
```bash
77
+
Welcome to TikTokLiveMCBE!
78
+
✔ Enter TikTok username (must be live): rqinix
79
+
✔ Enter the port number: 3000
80
+
? Select plugins to activate: (Press <space> to select, <a> to toggle all, <i> to invert selection, and <enter> to
81
+
proceed)
82
+
❯◯ TNT Coin by Rqinix
83
+
```
84
+
85
+
```bash
86
+
Welcome to TikTokLiveMCBE!
87
+
✔ Enter TikTok username (must be live): rqinix
88
+
✔ Enter the port number: 3000
89
+
✔ Select plugins to activate: TNT Coin by Rqinix
90
+
✔ Connected to rqinix TikTok Live Stream.
91
+
Open Minecraft and run this command'/connect localhost:3000' to connect.
92
+
<Ctrl + C> to stop the server.
93
+
```
94
+
95
+
6.**Connect Minecraft to TikTokLiveMCBE**
96
+
97
+
Once TikTokLiveMCBE is successfully connected to the live stream, open Minecraft and connect to the server using the following command:
88
98
89
-
In your Minecraft, connect to the server by typing the following command:
90
99
```bash
91
100
/connect localhost:3000
92
101
```
93
-
Replace `localhost` with your server’s IP address if you are not running it locally.
94
102
95
-
## Usage
103
+
This command establishes the connection between Minecraft and TikTokLiveMCBE. Make sure the port matches the one configured during the setup process.
104
+
105
+
---
96
106
97
-
### Subscribe to Minecraft Events
107
+
##Subscribing to Minecraft Events
98
108
99
-
In your application file (e.g. `app.ts`), you can subscribe to Minecraft events like this:
TikTokLiveMCBE supports custom plugins to extend its functionality. Each plugin must have its own folder containing two files:
229
233
230
-
// Enable the TNTCoin extension
231
-
useTNTCoin();
234
+
1.`manifest.json`
235
+
- This file describes the plugin's metadata.
232
236
233
-
//...
237
+
Below is an example:
234
238
```
235
-
236
-
The TNTCoin extension listens for various TikTok events, such as join, like, chat, and gift events, and sends corresponding script events to Minecraft. These script events include messages containing relevant information, such as the nickname and unique ID of the user who triggered the event.
237
-
238
-
For example, when someone joins the stream, the extension sends a `tntcoin:join` script event to Minecraft, containing the nickname and unique ID of the user who joined:
"description": "A custom plugin for TikTokLiveMCBE.",
243
+
"author": "Your Name"
244
+
}
255
245
```
256
-
You can also run this manually in-game if you want to test a function that runs when script event like `tntcoin:join` sent without connecting to server:
257
246
258
-
<div>
247
+
Ensure `manifest.json` includes `name`, `version`, `description`, and `author`.
If you’ve created a plugin that you’d like to share with the community, feel free to open a pull request or contribute to the TikTokLiveMCBE repository.
0 commit comments