设置 IntelliJ IDEA¶
这一部分介绍了如何为开发基于 SpongeAPI 的插件,设置你的 IntelliJ IDEA 工作目录,并 使用一些诸如 Maven 或 Gradle 的构建系统或 Minecraft Development plugin。
如果你想从零开始新建项目,请直接忽略 Gradle 和 Maven 两小节。使用 Minecraft Dev 插件来配置工作环境可以省去很多不必要的麻烦。
使用 IDEA 的 Minecraft Dev 插件新建项目起点¶
由社区成员开发的 Minecraft Development 插件在使开发环境的部署更简单的同时,还提供了大量开发时有用的功能,默认它会使用 Gradle 作为你新建项目的构建工具。
安装 Minecraft Dev 插件¶
你可以在 JetBrains 的 Intellij 插件仓库(plugin repository)中找到该插件。
因此你可以直接通过 Intellij 的插件浏览器安装该插件。依次点击 File -> Settings -> Plugins
,然后点击弹出的窗口底部的 Browse Repositories...
按钮。在搜索框中直接搜索 Minecraft
。找到插件后就可以直接安装,并重启 Intellij 以激活插件了。
使用模板创建新项目¶
- 打开 IntelliJ IDEA 。
- 单击
Create New Project
。 - 在弹出的窗口中选择
Minecraft
。 - 确保你的 Project SDK 使用了 Java8/1.8 的某个版本。
- 选择
Sponge plugin
作为项目类型,然后点击Next
继续。 - 输入你的 Group ID , Artifact ID ,和 Version 。
- 选择你想用的构建工具,通常是 Gradle 和 Maven 二选一,然后点击
Next
继续。 - 检查你的 Plugin Name 和 Main Class Name,确保它们的值是你想设定的值。
- 按需声明你的插件的描述、作者、网站及依赖。
- 点击
Next
继续。 - 检查项目名、位置及模块信息,然后点击
Finish
。 - 该插件将会新建一个 Java 文件作为入口,并已配置好 logger 的依赖注入。你可以通过在
onServerStart
中加一句logger.info()
来验证其是否能正常工作。
从零开始新建插件——Gradle 篇¶
- 打开 IntelliJ IDEA 。
- 单击
Create New Project
。 - 在弹出的窗口中选择
Gradle
。 - 你可以按需选择更多的库和框架,比如 Kotlin。
- 确保你的 Project SDK 使用了 Java8/1.8 的某个版本。
- 点击
Next
继续。 - 输入你的 Group ID , Artifact ID ,和 Version 。
- 点击两次
Next
并命名你的项目,然后点击Finish
。 - 插件项目新建完后并不会生成
src
目录,如果你的 Java 源文件放在了错误的位置,它们将不会被识别并编译,所以你应该勾选 “Create directories for empty content roots” 选项,它的位置是:- Windows:
File
->Settings
->Build, Execution, Deployment
->Gradle
- Mac:
Intellij IDEA
->Preferences
->Build, Execution, Deployment
->Build Tools
->Gradle
- Windows:
- 启用
Use Auto-import
后可以自动在 Gradle 配置发生变化时自动刷新项目,而不是每次询问是否刷新。 - 启用这些选项后,此时应该会有
/src/main/java
目录自动生成完毕,你在这个目录里可以开始写插件了。
调试插件¶
下述流程可以用来快速调试插件,但并不适合快速迭代开发。
使用 Gradle 编译出 .jar
文件:
- 依次点击
View
->Tool Windows
->Gradle
- 在
Tasks
->Build
中,点击jar
- 构建结果可在
build\libs
中找到。
使用 Maven 编译出 .jar
文件:
- 依次点击
View
->Tool Windows
->Maven Projects
- 在
Maven Projects
窗口中,展开你的项目名称 - 在
Plugins
中展开jar
- 双击
jar:jar
- 构建结果可在
target
中找到。
将构建出的 jar 文件复制到可以运行的服务器的 mods
文件夹中,重启服务器以测试。
关于更高效的开发流程,请参阅 调试插件 中有关在 IDEA 中运行 Sponge 服务器的说明。在 IDEA 中运行 Sponge 服务器可以让你使用热重载功能,使得你可以在不重启服务器的情况下替换一部分插件代码。
导入现有项目(Gradle 或 Maven)¶
如果你已经开始你的项目开发工作了,而且想要稍后在 IDE 中打开它,那么你需要去直接导入它而不是在 IDE 中再次创建。
- 点击
File > Open
或Import Project
。 - Gradle:浏览到项目目录中的
build.gradle
,选中。 - Maven:浏览到项目目录中的
pom.xml
,选中。 - 确认所有选项均设置正确,然后点击
Ok
。
Git 集成¶
JetBrains 提供了详细的使用他们的 Git 集成的文档:
https://www.jetbrains.com/help/idea/using-git-integration.html