WoWChat 开源项目安装与使用教程
1. 项目目录结构及介绍
WoWChat 项目的目录结构如下:
wowchat/
├── src/
│ ├── main/
│ │ ├── java/
│ │ └── scala/
│ └── test/
│ ├── java/
│ └── scala/
├── target/
│ └── wowchat-1.3.8.zip
├── wowchat.conf
├── run.bat
├── run.sh
├── pom.xml
└── README.md
目录结构介绍:
src/
: 包含项目的源代码,分为main/
和test/
两个部分。main/
: 包含主要的 Java 和 Scala 源代码。test/
: 包含测试代码。
target/
: 包含编译后的输出文件,如wowchat-1.3.8.zip
。wowchat.conf
: 项目的配置文件。run.bat
: Windows 系统下的启动脚本。run.sh
: Mac/Linux 系统下的启动脚本。pom.xml
: Maven 项目配置文件。README.md
: 项目说明文档。
2. 项目启动文件介绍
Windows 系统
在 Windows 系统下,启动 WoWChat 的步骤如下:
- 编辑
wowchat.conf
配置文件。 - 运行
run.bat
脚本。
Mac/Linux 系统
在 Mac/Linux 系统下,启动 WoWChat 的步骤如下:
- 编辑
wowchat.conf
配置文件。 - 运行
run.sh
脚本。
手动编译与启动
如果你选择手动编译并启动 WoWChat,步骤如下:
- 确保已安装 Java JDK 1.8 或更高版本。
- 运行
mvn clean package
命令,生成wowchat-1.3.8.zip
文件。 - 解压
wowchat-1.3.8.zip
文件。 - 编辑配置文件
wowchat.conf
。 - 运行以下命令启动 WoWChat:
如果没有提供配置文件,WoWChat 将尝试使用默认的java -jar wowchat.jar <config file>
wowchat.conf
文件。
3. 项目配置文件介绍
WoWChat 的配置文件为 wowchat.conf
,该文件包含了 WoWChat 运行所需的各种配置参数。以下是配置文件的主要内容:
# WoWChat 配置文件示例
# Discord 配置
discord {
token = "your_discord_token"
channel = "your_discord_channel_id"
}
# World of Warcraft 配置
wow {
realm = "your_wow_realm"
character = "your_wow_character"
}
# 其他配置
logLevel = "INFO"
配置文件参数说明:
discord.token
: Discord 的 API 令牌。discord.channel
: Discord 频道 ID。wow.realm
: World of Warcraft 服务器名称。wow.character
: World of Warcraft 角色名称。logLevel
: 日志级别,可选值为DEBUG
,INFO
,WARN
,ERROR
。
通过编辑 wowchat.conf
文件,你可以自定义 WoWChat 的行为和连接的服务器及频道。