CoffeeStreams

☕ CoffeeStreams Live Stream Integration for SMPs

CoffeeStreams is a lightweight Paper 1.21+ plugin that lets players link their live streams directly in-game. Designed for SMPs and creator-friendly servers, it provides a clean way to showcase streamers.

⚠️ Configuration is REQUIRED before use.
This plugin will not function correctly out of the box until API keys are set.

---

✨ Features

• 🔗 Player stream linking with /stream
• 📺 Streams GUI via /streams
• 🛠 Staff approval system for streamers
• 🚀 Lightweight & SMP-friendly
• 💤 Streams persist across restarts

---

⚙️ REQUIRED CONFIGURATION (IMPORTANT)

Before using CoffeeStreams, you must configure API credentials in config.yml.

Required

• YouTube Data API key
  Used to detect live status and viewer counts

Optional (but recommended)

• Twitch Client ID
• Twitch Client Secret

Without these:

• Live status will not update
• Viewer counts will not display
• /streams may show offline or empty results

➡️ Restart the server after editing config.yml.

---

🧑‍💻 Commands

Command	Description
/stream <url>	Set your stream link
/stream remove	Remove your stream
/stream approve <player>	Approve a streamer (staff)
/stream unapprove <player>	Unapprove a streamer
/streams	Open the streams GUI

---

🔐 Permissions

Permission	Description
coffeestreams.stream	Use /stream
coffeestreams.streams	Use /streams
coffeestreams.stream.approve	Approve / unapprove streamers

---

🧩 Requirements

• Paper 1.21+
• Java 21
• YouTube Data API key (REQUIRED)
• Twitch API credentials (optional)

---

📦 Installation

1. Download the plugin
2. Place the .jar into /plugins
3. Start the server once
4. Open plugins/CoffeeStreams/config.yml
5. Add required API keys
6. Restart the server ☕

---

⚠️ Notes

• API credentials are not included for security reasons
• Each server must use its own keys
• Missing or invalid keys will cause features to be disabled