Skip to content

Purpur

Purpur 图片

MIT 许可证  Github Actions 构建 CodeFactor  加入我们的 Discord 

Purpur 的点赞者  Purpur 的分支  Purpur 的关注者 

欢迎访问 Purpur  项目的官方文档。

本文档适用于构建  #2240 （c0f5e78）

Purpur 是 Paper 服务器的一个可配置的、设计新颖且充满乐趣的游戏功能的替代品。

联系 Discord shield.io🔗

加入我们的 Discord！

下载🔗

你可以从 下载页面或下载 API下载 Purpur。

下载 API：

  • 列出具有可用构建的 Minecraft 版本：
    https://api.purpurmc.org/v2/purpur/
  • 列出某个 Minecraft 版本的构建：
    https://api.purpurmc.org/v2/purpur/<version>
  • 下载特定版本的特定构建：
    https://api.purpurmc.org/v2/purpur/<version>/<build>/download
  • 下载 Minecraft 版本的最新构建：
    https://api.purpurmc.org/v2/purpur/<version>/latest/download

许可证 MIT 许可证🔗

该项目将所有补丁都授权为 MIT 许可证，除非补丁的最开始处另有说明。

有关此项目使用的材料许可，请参阅PaperMC/Paper。

bStats🔗

API🔗

Javadoc🔗

你可以在这里找到 Purpur 的 Javadoc：https://purpurmc.org/javadoc

依赖信息🔗

1
2
3
4
5
6
7
8
9
<repositories>
    <!-- 其他仓库... -->
    <repository>
        <id>purpur</id>
        <name>Purpur Maven 仓库</name>
        <url>https://repo.purpurmc.org/snapshots</url>
    </repository>
    <!-- 其他仓库... -->
</repositories>

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
<dependencies>
    <!-- 其他依赖 -->
    <dependency>
        <groupId>org.purpurmc.purpur</groupId>
        <artifactId>purpur-api</artifactId>
        <version>1.21-R0.1-SNAPSHOT</version>
        <scope>provided</scope>
    </dependency>
    <!-- 其他依赖 -->
</dependencies>


1
2
3
4
5
6
7
8
repositories {
    //... 其他仓库 ...//

    //在 mavenCentral() 之后的某处添加以下内容
    maven("https://repo.purpurmc.org/snapshots")

    //... 其他仓库 ...//
}

1
2
3
4
5
6
7
dependencies {
    //... 其他依赖 ...//

    compileOnly("org.purpurmc.purpur", "purpur-api", "1.21-R0.1-SNAPSHOT")

    //... 其他依赖 ...//
}


 1
 2
 3
 4
 5
 6
 7
 8
 9
10
repositories {
    //... 其他仓库 ...//

    //在 mavenCentral() 之后的某处添加以下内容
    maven {
        url "https://repo.purpurmc.org/snapshots"
    }

    //... 其他仓库 ...//
}

1
2
3
4
5
6
7
dependencies {
    //... 其他依赖 ...//

    compileOnly "org.purpurmc.purpur:purpur-api:1.21-R0.1-SNAPSHOT"

    //... 其他依赖 ...///
}

将 Purpur 导入到你的项目中还会包括 Pufferfish、Paper、Spigot 和 Bukkit 提供的所有 API。

构建和设置🔗

初始设置🔗

在项目目录的根目录中运行以下命令：

1
./gradlew applyPatches

创建一个补丁🔗

补丁实际上只是 Purpur-API 或 Purpur-Server 中的提交。要创建一个补丁，只需向任一存储库添加一个提交，然后运行 ./gradlew rebuildPatches，Gradle 将在补丁文件夹中放置一个补丁。修改提交也会修改其相应的补丁文件。

有关更详细的信息，请参阅CONTRIBUTING.md。

编译🔗

使用命令 ./gradlew build 来构建 API 和服务器。Gradle 将在 Purpur-API/build/libs 和 Purpur-Server/build/libs 下放置编译的 jar 文件。

要获取 purpurclip jar，运行 ./gradlew paperclip。 要将 purpur-api 和 purpur 依赖项安装到你的本地 maven 仓库，请运行 ./gradlew publishToMavenLocal