docs: 添加自述文档

添加自述文档
This commit is contained in:
2022-10-23 05:50:21 +08:00
parent bcd0410fe1
commit a81d8ea3cf

54
README.md Normal file
View File

@@ -0,0 +1,54 @@
# HamsterCore
仓鼠核心Minecraft 插件开发通用工具包
# 添加依赖
## 对于 Gradle (`build.gradle`)
```groovy
// 添加仓库
repositories {
maven {
url "https://maven.airgame.net/maven-public"
}
}
dependencies {
// 对于 Bukkit 插件
compileOnly "cn.hamster3.mc.plugin:hamster-core-bukkit:1.0.0"
// 对于 BungeeCord 插件
compileOnly "cn.hamster3.mc.plugin:hamster-core-bungeecord:1.0.0"
}
```
## 对于 Maven (`pom.xml`)
```xml
<project>
<!--添加仓库-->
<repositories>
<repository>
<id>airgame-repo-maven-public</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>hamster-core-bukkit</artifactId>
<version>1.0.0</version>
</dependency>
<!--对于 BungeeCord 插件-->
<dependency>
<groupId>cn.hamster3.mc.plugin</groupId>
<artifactId>hamster-core-bungeecord</artifactId>
<version>1.0.0</version>
</dependency>
</dependencies>
</project>
```