update README.md

This commit is contained in:
zhangyuheng 2024-03-26 11:02:05 +08:00
parent bc89d32e8b
commit 51f47843b4
3 changed files with 21 additions and 14 deletions

View File

@ -2,5 +2,8 @@
<project version="4">
<component name="VcsDirectoryMappings">
<mapping directory="" vcs="Git" />
<mapping directory="$PROJECT_DIR$/deer-folia-api" vcs="Git" />
<mapping directory="$PROJECT_DIR$/deer-folia-server" vcs="Git" />
<mapping directory="$PROJECT_DIR$/paper-api-generator/generated" vcs="Git" />
</component>
</project>

View File

@ -1,6 +1,9 @@
# DeerFolia
DeerFolia 是一个基于 Folia 的 Minecraft 服务器核心,它是由 [Mojang](https://mojang.com) 的 Minecraft 服务器核心 [Paper](https://papermc.io) 修改而来。
DeerFolia 是一个基于 [Folia](https://papermc.io/software/folia) 的 Minecraft
服务器核心,它是由 [Mojang](https://mojang.com) 的 Minecraft 服务器核心 [Paper](https://papermc.io) 修改而来。
![](https://ssl.lunadeer.cn:14437/i/2024/03/26/660237f7388c3.png)
## 此分支特性
@ -9,15 +12,13 @@ DeerFolia 是一个基于 Folia 的 Minecraft 服务器核心,它是由 [Mojan
## 更新上游 Folia 修改
1. 克隆此仓库到本地;
2. 在终端执行 `./gradlew updateFoliaRef` 更新上游 Folia 修改;
1. 在终端执行 `./gradlew updateFoliaRef` 更新上游 Folia 修改;
## 将补丁应用到 Folia 源码
1. 在终端执行 `./gradlew applyPatches` 应用补丁;
2. 完成后会在项目目录下生成 `deer-folia-server``deer-folia-api` ,前者即为源码目录;
## 生成服务器核心
1. 应用补丁;
@ -37,9 +38,12 @@ DeerFolia 是一个基于 Folia 的 Minecraft 服务器核心,它是由 [Mojan
这种方法的工作原理是暂时将 `HEAD` 重置为所需的提交,然后使用 `git rebase` 进行编辑。
> ❗ 在编辑过程中,除非您 *同时* 将对应模块重置为相关提交,否则将无法编译。就 API 而言,您必须重新应用 Server 补丁,如果正在编辑 Server 补丁,则必须重新应用 API 补丁。还要注意的是,这样做时任何一个模块都可能无法编译。这不是一个正常的现象,但这种情况时有发生。请给 Paper 官方提交 ISSUE
> ❗ 在编辑过程中,除非您 *同时* 将对应模块重置为相关提交,否则将无法编译。就 API 而言,您必须重新应用 Server 补丁,如果正在编辑
> Server 补丁,则必须重新应用 API 补丁。还要注意的是,这样做时任何一个模块都可能无法编译。这不是一个正常的现象,但这种情况时有发生。请给
> Paper 官方提交 ISSUE
1. 在 `deer-folia-server``deer-folia-api` 目录中执行 `git rebase -i base` ,应该会输出 [这样的](https://gist.github.com/zachbr/21e92993cb99f62ffd7905d7b02f3159) 内容。
1. 在 `deer-folia-server``deer-folia-api` 目录中执行 `git rebase -i base`
,应该会输出 [这样的](https://gist.github.com/zachbr/21e92993cb99f62ffd7905d7b02f3159) 内容。
2. 将你需要修改的补丁由 `pick` 替换为 `edit` 然后保存退出;
- 一次只能修改 **一个** 文件!
3. 对你需要修改的补丁作出新的修改;

BIN
resources/DeerFolia.xmind Normal file

Binary file not shown.