如何制作CraftBukkit插件

如何制作CraftBukkit插件

开始一个插件项目创建项目在开始之前,你需要在 Eclipse 里建立你的工作空间和文件。运行 Eclipse ,然后点击 File(文件)> New(新建)> Java Project(Java项目)创建一个新项目:给你的项目取个名字,然后运行这个新的项目,根据屏幕上的介绍进行配置。左边的Package Explorer(包浏览栏)里会出现一个文件夹,左键点击它旁边的小箭头会显示你的项目的内容。查阅Bukkit API在编写插件前,你需要向你的项目里以外部JAR的形式添加Bukkit API。你也可以添加其他你可能会用到的API。最新版已编译的Bukkit API 可在这里找到: Bukkit API – 开发快照点击左边Package Explorer(包浏览栏)内有着你的项目名称的文件夹并选择 Properties(选项). 在左边的方框内选择Java Build Path(Java生成路径) ,之后里面的内容就会变化。点击 Add External JARs(添加外部JAR) 并载入你下载的 Bukkit API.Bukkit的Java注释文档如果你已经有Eclipse和Java的使用经验,你就会知道当鼠标放在类或者方法上面时,一个黄色的包含其说明文档的小盒子就会出现。这就是Javadoc(Java文档注释),在Oracle 官网 上也可以查阅到其资料。Bukkit也有包含了每个方法和类的有用描述的注释文档,你可以在这里查看它。为了让Ecilpse能载入注释信息以便我们能方便的查看Bukkit中类和方法的注释,你需要首先左键点击项目浏览器中"Referenced Libraries(参考库)"内的Bukkit jar,点击"Properties(选项)",选择左边的"Javadoc Location(Java注释文档位置)" ,然后复制http://jd.bukkit.org/apidocs/到"Javadoc URL(Java注释文档地址)"中。Bukkit的Java注释文档如果你已经有Eclipse和Java的使用经验,你就会知道当鼠标放在类或者方法上面时,一个黄色的包含其说明文档的小盒子就会出现。这就是Javadoc(Java文档注释),在Oracle 官网 上也可以查阅到其资料。Bukkit也有包含了每个方法和类的有用描述的注释文档,你可以在这里查看它。为了让Ecilpse能载入注释信息以便我们能方便的查看Bukkit中类和方法的注释,你需要首先左键点击项目浏览器中"Referenced Libraries(参考库)"内的Bukkit jar,点击"Properties(选项)",选择左边的"Javadoc Location(Java注释文档位置)" ,然后复制http://jd.bukkit.org/apidocs/到"Javadoc URL(Java注释文档地址)"中。命名规则如下:§ 如果你有一个域名,包的名称就是域名反过来。§ 例如:i-am-a-bukkit-developer.com 那你的包名就会是com.i_am_a_bukkit_developer 源§ 不要使用你不拥有的域名§ 没有域名?看看这些:1. 在github 或 sourceforge 这类存放源文件的网站上注册一个帐号§ 对github,根据 这里面 的教材注册就能得到一个子域名,这样你的包名就是com.github.2. 使用你的邮箱,如:@gmail.com –> com.gmail.3. 这是最不推荐的方法:使用任意独有的包名。你的包名绝对不能是:§ org.bukkit§ net.bukkit§ com.bukkit§ net.minecraft下一步就是加上插件名称。让我们再以github为例:如果你的插件名字叫"TestPlugin",你的完整包名就是 "com.github..testplugin"。创建插件的类创建完项目或,我们就可以添加类并编写插件了。插件的主类(main class)必须要继承 JavaPlugin 类。你的插件里需要有且只能有一个类直接或间接继承 JavaPlugin 类。强烈建议先创建你的主类,并将其命名与插件名称一致。右键点击你之前创建的包,选择 New(新建)> Class(类)。你的类格式应如下:package {$TopLevelDomain}.{$Domain}.{$PluginName};import org.bukkit.plugin.java.JavaPlugin;public final class {$PluginName} extends JavaPlugin {}创建plugin.yml你现在已经创建了你的项目和主文件。为了让bukkit能看到它,我们需要添加 plugin.yml 文件。它包含了插件的必备信息,离开它插件就无法工作。这次我们要右键点击项目文件夹,选择 New(新建)> File(文件),命名为 "plugin.yml"后点击确定。 Eclipse 会在默认文档编辑器中打开一个空白的 plugin.yml 文件。 (提示:如果你想让你的工作空间井井有条,关闭文本编辑器并把plugin.yml拖动到主工作空间右边,就能在eclipse中直接编辑了。) 该文件中有三条信息必不可少:插件名称,插件主文件的完全限定名称,和插件的版本。最简单的 plugin.yml 文件如下图所示:name:{$PluginName}main:{$PackageName}.{$MainClass}version:{$VersionNumber}注意:插件的包的名字常常会包含插件的名字,因此在第二行末尾看到 . 字样时不必感到惊讶。注意:你的主类是否要与插件名称一致取决于你之前的命名,注意其区分大小写。现在你的插件可以被 Bukkit载入了,并且也会被记录下来。但它什么也干不了!