PhantomBot 开发者指南
1. 项目介绍
PhantomBot 是一个由社区积极开发的开源 Twitch 聊天机器人项目。它为您的 Twitch 频道提供娱乐和调制功能,帮助您专注于最重要的任务——游戏和观众。PhantomBot 拥有众多现代功能,包括内置的网页控制面板、增强调制、游戏、积分系统、抽奖、自定义命令、音乐播放器等。此外,它还可以与 Discord、TipeeeStream、StreamLabs 和 StreamElements 等服务集成。
2. 项目快速启动
安装环境
在开始之前,请确保您的系统满足以下要求:
- 架构:armv7 (Raspberry Pi without 64-bit) 或 x86 (32-bit)
- Java 环境:Eclipse Temurin 17 (支持 x86_64, arm64, aarch64, 和 Apple Silicon 64-bit 架构)
克隆项目
首先,您需要克隆项目到本地环境:
git clone https://github.com/PhantomBot/PhantomBot.git
cd PhantomBot
配置
进入项目目录后,根据您的需求配置 botlogin.txt
文件,该文件包含了机器人运行的基本配置信息,例如 Twitch 频道名称、机器人用户名等。
运行
使用以下命令启动 PhantomBot:
java -jar PhantomBot.jar
访问控制面板
在机器人启动后,您可以通过浏览器访问内置的网页控制面板,默认端口为 8080:
http://localhost:8080/
3. 应用案例和最佳实践
基础调制
PhantomBot 提供了多种调制工具,例如自动封禁关键字、自动欢迎新观众、定时发送消息等。通过控制面板或配置文件,您可以轻松设置这些功能。
积分系统
您可以通过积分系统奖励积极参与频道的观众。例如,设置观众发言获得积分,积分可以用来参与抽奖或兑换礼物。
音乐播放
PhantomBot 内置了音乐播放器功能,允许您通过机器人播放音乐。您可以根据需要添加歌曲列表,并在直播时控制播放。
4. 典型生态项目
PhantomBot 社区开发了许多第三方模块,扩展了机器人的功能。以下是一些典型的生态项目:
- Discord Integration: 允许您将 Twitch 频道与 Discord 服务器集成。
- StreamLabs/StreamElements Integration: 集成这些服务以提供更丰富的直播体验。
- TipeeeStream Integration: 集成 TipeeeStream 进行打赏和订阅管理。
通过以上指南,您应该能够开始使用 PhantomBot 并将其集成到您的直播流程中。祝您使用愉快!