minster586
90666d0ac9
First upload working on it still having trouble with issues not showing the username but this is a start
42 lines
1.6 KiB
Markdown
42 lines
1.6 KiB
Markdown
# Stream Chat
|
|
|
|
A client-side Fabric mod that displays Twitch, YouTube, and TikTok live-stream
|
|
events in Minecraft. Twitch and YouTube events are received from Streamer.bot;
|
|
TikTok events are received from TikFinity.
|
|
|
|
## Current status
|
|
|
|
The project is at its initial implementation stage. The default and currently
|
|
verified build target is Minecraft 26.1.2 with Fabric. A separate legacy
|
|
client source set is retained for Minecraft 1.20.1.
|
|
|
|
## Initial setup
|
|
|
|
1. Install Fabric Loader 0.20.1 and Fabric API 0.155.3 for Minecraft 26.1.2.
|
|
2. Install Mod Menu to open the mod's settings screen from the Mods menu.
|
|
3. Configure the Streamer.bot and TikFinity WebSocket addresses in
|
|
`config/stream-chat.json` or in the in-game settings.
|
|
4. Start Streamer.bot/TikFinity and launch Minecraft. Enabled integrations
|
|
connect automatically; use the configured keybind or settings screen to
|
|
toggle them.
|
|
|
|
The Streamer.bot password, when configured, is stored as plain text in the
|
|
local Minecraft config file. Do not share that file or diagnostic logs without
|
|
checking them for private information.
|
|
|
|
The mod is client-only. It does not send stream events or chat messages to the
|
|
Minecraft server.
|
|
|
|
## Development
|
|
|
|
Use Java 25 for the Minecraft 26.1.2 target. Build with Gradle:
|
|
|
|
```text
|
|
gradlew build
|
|
```
|
|
|
|
The Minecraft version, Fabric Loader, Fabric API, Mod Menu, Loom, and Java
|
|
versions are declared in `gradle.properties`. Select matching versions there
|
|
before building a different Minecraft target. The legacy 1.20.1 source set
|
|
was verified separately; other releases need their own compatibility checks.
|