# StreamLink Documentation
Integrate streaming platform chats directly into the game with real-time message synchronization.
***
### What is StreamLink?
StreamLink is a powerful **server-side mod for Hytale** that seamlessly integrates streaming platforms directly into your gameplay. Transform passive viewers into active participants by displaying live chat messages, triggering in-game notifications for stream events, and creating truly interactive streaming experiences.
#### Core Features
**Real-Time Chat Integration**
* Display Twitch and YouTube chat messages directly in-game
* Color-coded usernames and role-based badges
* Support for emotes and special formatting
**Live Event Notifications**
* In-game alerts for follows, subscriptions, raids, and more
* Visual notifications with custom item icons and colors
* Fully integrated with Twitch EventSub
**Modern Dashboard UI**
* Easy credential management via `/streamlink ui`
* Real-time connection status indicators
* Secure credential masking for privacy
**Secure & Isolated**
* User-controlled authentication (no centralized credentials)
* Per-player credential storage
* Complete isolation between streamers
**Automatic Updates**
* Built-in update checker for operators
* Notifications on login for new versions
* Easy one-click upgrade process
***
### Platform Support
| Platform | Status | Features |
| ----------- | --------------- | ------------------------------ |
| **Twitch** | **Live** | Chat, Events, Badges, EventSub |
| **YouTube** | **Live** | Chat, Badges, Polling API |
| **Kick** | **Coming Soon** | Planned for future release |
***
### Main Functionality
#### For Streamers
**Chat Display**
* See your Twitch/YouTube chat without alt-tabbing
* Keep playing while staying connected with viewers
* Colored names and badges for easy recognition
**Event Notifications**
* Never miss a follow, sub, or raid
* Beautiful in-game notifications with sound effects
* Customizable notification settings
**Easy Setup**
* Visual dashboard for configuration
* Step-by-step setup guides
* No programming knowledge required
#### For Viewers
**Direct Interaction**
* Chat messages appear instantly in-game
* Streamers can respond without leaving the game
* See your username and badge displayed
**Event Recognition**
* Your follows, subs, and raids trigger in-game events
* Become part of the gameplay experience
* Enhanced streamer-viewer connection
#### For Server Owners
**Multi-Streamer Support**
* Multiple streamers can use StreamLink simultaneously
* Isolated credentials per player
* No interference between connections
**Performance Optimized**
* Lightweight design (\~10-20MB RAM per connection)
* Automatic cleanup on logout
* No lag or server impact
***
### Quick Start
#### Installation
1. **Download** StreamLink from [CurseForge](https://www.curseforge.com/hytale/mods/streamlink) or [ModTale](https://modtale.net/mod/streamlink-3698e5dc-636a-4565-a42b-fb0dc57d3714)
2. **Place** the JAR file in your server's `mods/` folder
3. **Restart** your Hytale server
4. **Configure** via `/streamlink ui` command
#### Basic Usage
```bash
# Open the dashboard
/streamlink ui
# Or use commands directly
/sl twitch setup
/sl twitch set
/sl twitch connect
```
**That's it!** You're now streaming with in-game integration.
***
### Documentation
#### Getting Started
* [**Installation Guide**](#installation) - Download and install StreamLink
#### Platform Guides
* [**Twitch Setup**](/streamlink/guides/twitch-setup-guide.md) - Complete Twitch integration guide
* [**YouTube Setup**](/streamlink/guides/youtube-setup-guide.md) - Complete YouTube integration guide
#### Commands Reference
* [**Core Commands**](/streamlink/commands/core-commands.md) - Base `/sl` commands
* [**Twitch Commands**](/streamlink/commands/twitch-commands.md) - All `/sl twitch` commands
* [**YouTube Commands**](/streamlink/commands/youtube-commands.md) - All `/sl youtube` commands
***
### Stats
* **Current Version:** 1.2.0
* **Hytale Version:** 0.0.1+
* **Java Version:** 25
* **License:** All Rights Reserved
* **Downloads:** Available on CurseForge & ModTale
***
### Acknowledgments
* **Twitch** - For EventSub API and IRC chat interface
* **YouTube** - For YouTube Data API v3
* **Java-WebSocket** - WebSocket library for EventSub
* **Hytale Community** - For modding documentation and support
* **Streamers** - For testing and feedback
***
### License
**All Rights Reserved** © 2025 KentaTetsu
This software is proprietary. Unauthorized copying, distribution, or modification is prohibited. However, third-party distribution for community access is permitted.
***
**Made with 💜 for the Hytale streaming community**
*Last Updated: January 2025 • Version 1.2.0*
---
# Agent Instructions: Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter:
```
GET https://kentatetsu.gitbook.io/streamlink/streamlink-documentation.md?ask=
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.