MC插件制作新手教程

一. 制作前的准备
- IDE(Integrated Development Environment,集成开发环境)
- 下载依赖jar包
二. 开始开发
三. 插件实例

本文主要介绍MC插件如何制作,以及制作一个简单的插件.

注：此教程的系统环境为windows,制作的是spigot插件.

此外,此教程假设你有基本的JAVA编程基础,不会过多介绍JAVA编程与编辑器.

一. 制作前的准备

IDE(Integrated Development Environment,集成开发环境)

开发java项目必须有编辑器,总不能使用纯文本编辑器吧,一般都用IDE,也就是集成开发环境来进行开发, 集成开发环境会集成很多有用的功能来简化开发,如智能提示与自动编译等．

如果你没有在用的IDE,推荐使用myeclipse(eclipse的’扩展版’,集成了很多有用的插件)或idea.

下载依赖jar包

在之前的MC插件制作介绍里介绍过, 如果开发spigot插件,那么依赖jar包有两种选择, 一种是依赖接口Spigot-Api.jar, 一种是依赖实现Spigot.jar

下载请参考服务端下载,如果使用官方下载,那构建的文件夹里会有spigot接口的jar包,如果使用第三方下载,那一般只能下载到spigot实现的jar包,也就是可以用来直接开服的服务端文件

二. 开始开发

简单步骤如下:

新建普通的java项目
添加依赖jar包(上面下载的,推荐添加接口jar包,下载不到添加实现jar包也可以)
新建主类(继承org.bukkit.plugin.java.JavaPlugin的类)

新建插件描述文件plugin.yml,内容:

name: 插件名
main: 主类路径(如com.kongkongye.mcplugin.jointip.JoinTipPlugin)
version: 版本(没有版本格式要求,就是一个字符串,如1.0)

构建产生jar包(记得把plugin.yml添加进jar包根目录下)
把产出的jar包放进服务端插件文件夹内,重启服务端即可生效

三. 插件实例

这里我们开发个简单的插件: 自定义玩家进服提示.

1. 新建项目

新建java项目join-tip,添加依赖jar包

2. 新建插件描述文件

在项目内新建文件plugin.yml,内容:

name: join-tip
main: com.kongkongye.mcplugin.jointip.JoinTipPlugin
version: 1.0

3. 新建主类

新建类JoinTipPlugin,继承JavaPlugin,实现事件接口Listener,然后覆盖onEnable()方法,注册事件监听(registerEvents方法). 这样当玩家进服时,服务端会发出玩家进服事件(PlayerJoinEvent),因为此插件注册了此事件的监听,因此会执行相应的逻辑修改进服提示信息.

package com.kongkongye.mcplugin.jointip;

import org.bukkit.Bukkit;
import org.bukkit.event.EventHandler;
import org.bukkit.event.Listener;
import org.bukkit.event.player.PlayerJoinEvent;
import org.bukkit.plugin.java.JavaPlugin;

public class JoinTipPlugin extends JavaPlugin implements Listener{
  @Override
  public void onEnable() {
      Bukkit.getPluginManager().registerEvents(this, this);
  }

  @EventHandler
  public void onPlayerJoin(PlayerJoinEvent event) {
      event.setJoinMessage("欢迎"+event.getPlayer().getName()+"来到服务器~");
  }
}

4. 构建

构建jar包(打开jar包必须能在根目录下看到插件描述文件plugin.yml,不然服务端无法识别此插件信息), 将生成的jar包join-tip.jar放进服务端插件目录plugins

5. 测试

重启服务端,客户端进服后,可以看到聊天栏显示欢迎xxx来到服务器~.