Files
hamster-core/README.md

84 lines
2.3 KiB
Markdown

# [HamsterCore](https://git.airgame.net/MiniDay/hamster-core)
仓鼠核心:叁只仓鼠的 Minecraft 插件开发通用工具包
# 手动构建
1. 将源代码下载或克隆至本地
2. 在源代码根目录中打开命令行窗口
3. 命令行窗口中执行`./gradlew clean build`
4. 构建成品在 `build` 文件夹
也可访问我的[Jenkins网站](https://jenkins.airgame.net/job/opensource/job/hamster-core/)获取最新版
# 开发
## 添加依赖
<details>
<summary>Gradle</summary>
```groovy
// 添加仓库
repositories {
maven("https://maven.airgame.net/maven-public")
}
dependencies {
// 对于 Bukkit 插件
compileOnly("cn.hamster3.mc.plugin:core-bukkit:1.2.2")
// 对于 BungeeCord 插件
compileOnly("cn.hamster3.mc.plugin:core-bungee:1.2.2")
}
```
</details>
<details>
<summary>Maven</summary>
```xml
<project>
<!--添加仓库-->
<repositories>
<repository>
<id>airgame-repo</id>
<name>AirGame Maven仓库</name>
<url>https://maven.airgame.net/maven-public</url>
</repository>
</repositories>
<dependencies>
<!--对于 Bukkit 插件-->
<dependency>
<groupId>cn.hamster3.mc.plugin</groupId>
<artifactId>core-bukkit</artifactId>
<version>1.2.2</version>
</dependency>
<!--对于 BungeeCord 插件-->
<dependency>
<groupId>cn.hamster3.mc.plugin</groupId>
<artifactId>core-bungee</artifactId>
<version>1.2.2</version>
</dependency>
</dependencies>
</project>
```
</details>
## 使用 API
- 绝大部分 API 相关的方法都位于 `cn.hamster3.mc.plugin.core.common.api.CoreAPI` 类中
- 使用方法为:`CoreAPI.getInstance().xxx()`
- 部分通用的工具代码在 `cn.hamster3.mc.plugin.core.common.util` 包中
- 部分Bukkit的工具代码在 `cn.hamster3.mc.plugin.core.bukkit.util` 包中
- 部分BungeeCord的工具代码在 `cn.hamster3.mc.plugin.core.bungee.util` 包中
# 已知问题
部分 Windows 服务器在启动时偶尔会遇到 Redis 链接失败的问题
如果服务器启动时遇到报错 `Caused by: java.io.IOException: Unable to establish loopback connection`
可以通过在启动脚本中添加 `-Djava.net.preferIPv4Stack=true` 参数解决