NamLivechat

<div align="center"> (https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) (https://img.shields.io/github/stars/Nattapat2871/NamLivechat?style=flat-square)](https://github.com/Nattapat2871/Namlivechat/stargazers) !(https://api.visitorbadge.io/api/VisitorHit?user=Nattapat2871&repo=NamLivechat&countColor=%237B1E7A&style=flat-square) (https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/Nattapat2871) </div> <p align= "center"> <b>English</b> | <a href="README_TH.md">ภาษาไทย</a> </p> # NamLivechat Bridge the gap between your live stream and your Minecraft server. NamLivechat is a powerful, highly configurable plugin that brings your **YouTube**, **Twitch**, and **TikTok** live stream chats directly into the game. Keep your community engaged with real-time messages and a rich, customizable alert system without ever needing to switch screens. This plugin is built for performance and stability, with dedicated support for modern Folia and Paper servers. ## How It Works (Core Concept) The plugin uses different methods to connect to each platform, ensuring the most stable and efficient connection possible: - **YouTube:** Connects via the official **Google YouTube Data API v3** to poll for live chat messages and events. - **Twitch:** Connects to Twitch's real-time **IRC chat servers** for instant message delivery and uses the **Helix API** to monitor for events like new followers. - **TikTok:** Connects to TikTok's unofficial **Webcast service** using the `TikTokLiveJava` library, mimicking a web browser to receive real-time events like comments and gifts. ## ✨ Features - **Multi-Platform Support:** Connect to **YouTube**, **Twitch**, and **TikTok** live streams. - **Real-Time Chat:** Displays live chat messages directly in Minecraft, featuring colored usernames based on their roles on each platform. - **Comprehensive Event Alerts:** Get instant, highly customizable in-game notifications for all important events: - **YouTube:** Super Chat, Super Stickers, New Members, Gifted Memberships, and Member Milestones. - **Twitch:** New Followers, Subscriptions (New, Resubs), Gifted Subs, and Community Gift Bombs. - **TikTok:** New Followers and Gifts. - **Advanced Alert System:** Alerts are displayed in three configurable ways: - **Custom Chat Messages:** Design unique alert messages for each event. - **Configurable Sounds:** Assign specific sounds, volumes, and pitches for each alert. - **Dynamic Boss Bars:** Important alerts appear on a Boss Bar, **immediately replacing** any previous alert to show the latest event. - **Full Customization:** Almost every aspect is configurable via YAML files, including message formats, role colors, sounds, and Boss Bar styles. - **Multi-Language Support:** All user-facing plugin messages can be translated. Default files for **English (`en.yml`)** and **Thai (`th.yml`)** are provided. - **Semi-Automatic Updates:** - **Update Checker:** Automatically checks for new versions from GitHub and notifies admins upon joining. - **Update Command:** A simple command (`/namlivechat update`) downloads the latest version to the server's main `update` folder for a safe, automatic update on the next server restart. - **Debug Mode:** A simple toggle in the `config.yml` to show detailed console logs for easy troubleshooting. ## ⚙️ Compatibility - **Server Software:** **PaperMC & Folia** (100% compatible). - **Minecraft Version:** **1.21+** ## 📚 Installation & First-Time Setup 1. Download the latest `.jar` file from the (https://github.com/Nattapat2871/NamLivechat/releases) page. 2. Place the `NamLivechat-X.X.jar` file into your server's `plugins` folder. 3. Start your server once. The plugin will generate the following files and folders: - `plugins/NamLivechat/config.yml` - `plugins/NamLivechat/youtube-config.yml` - `plugins/NamLivechat/twitch-config.yml` - `plugins/NamLivechat/tiktok-config.yml` - `plugins/NamLivechat/messages/en.yml` - `plugins/NamLivechat/messages/th.yml` 4. Stop the server. 5. Follow the **API & Token Setup** guide below to configure the `youtube-config.yml` and `twitch-config.yml` files. 6. Start your server again and enjoy! ## 🔧 Configuration ### `config.yml` (Main Configuration) This file controls the global settings of the plugin. ```yml # ========================================= # # NamLivechat General Settings # # ========================================= # # Set the language for in-game messages. # Available languages are defined by the .yml files in the 'messages' folder. language: "en" # Set to true to enable detailed console logs for debugging purposes. # It is recommended to keep this false during normal use. debug-mode: false # ========================================= # # Update Settings # # =======================================