自製Nukkit伺服器插件入門: 自訂指令 & 歡迎訊息

Nukkit的插件(plugin)是以Java寫成的,對Bukkit的開發者來說應會比較熟悉。

(Nukkit開服教學看這裡)

本文教學如何在Windows上撰寫一個插件,放到伺服器上測試。

在玩家加入世界後會顯示一條歡迎訊息,還可以用指令呼叫自己的名字。




    安裝必要軟體

    1. 安裝JDK

    2. 安裝VSCode

    3. 下載Maven,解壓縮放到C槽的ProgramFiles。

    設定環境變數: Path指到maven資料夾底下的"bin"資料夾。

    4. 開啟VSCode,在左側安裝延伸模組: "Java Extension Pack"、"Maven or Java",記得安裝擴充元件後要重新啟動VSCode。


    5.按下F1,輸入maven,按下"Create Maven Project"

    按"maven-archetype-quickstart",接著選取版本1.4

    新增的專案可以取名為"com.example",接著輸入"exampleplugin"

    再從電腦裡選取一個英文名稱的資料夾儲存專案,例如在桌面新建一個"test"。

    終端機會開啟,輸入專案版本 (1.0)


    輸入Y確認。

    6. 建立完成後,按左上角「檔案」,開啟資料夾,開啟剛剛建立的"exampleplugin"這個資料夾。

    這個資料夾就是專案的「根目錄」。

    到這邊為止,VScode應該會跳出很多提示,要求安裝其他擴充元件,全部同意。


    設定開發環境

    1. 建立Maven專案之後,開啟"pom.xml",加入以下xml,


    這樣就能加入repository。

    右下角會有提示,按下Always。


    2.接著加入依賴庫,這樣能夠確保使用的是最新版的Nukkit。


    於是會長這樣:



    3.在根目錄/src/main/,新建"resources"資料夾,裡面新建"plugin.yml",此為插件的基本資料。

    main代表的是插件的主程式位置。


    插件主程式碼

    1. 切換到/src/main/java/com/example/App.class,刪除全部程式碼,改成以下程式碼:


    2. VSCode會自動把錯誤的地方標上波浪號,把滑鼠移過去,選取快速修復。按照建議將"App.java"改名"main.java",也就是plugin.yml裡寫的位置。


    3. 繼續新增程式碼。撰寫的時候若有用到沒匯入的類別,只要用快速修復匯入即可。


    4. 如果有新增指令,還要在plugin.yml註明,permission設定為op才可以使用。


    編譯成.jar檔案進行測試

    1.pom.xml裡<build>的<pluginManagement>的<plugins>標籤新增以下內容,mainClass裡寫的必須跟plugin.yml裡的main同一個位置。


    就會變成這樣:


    2. 按終端機,新增終端機,輸入 mvn install,出現"BUILD SUCCESS"就表示成功。


    3. 產生的jar檔案會放在根目錄/target/。


    3. 將jar檔案放到伺服器根目錄/plugins/,啟動伺服器。

    4. 終端機會看到插件載入的訊息。


    進入遊戲,出現歡迎文字。



    輸入指令"/sayhi",有出現提示,且成功呼叫自己的名字。





    參考資料

    留言

    此網誌的熱門文章

    Minecraft基岩版多人連線教學: 方法一覽

    【詳細解說】什麼是Minecraft基岩版,跟Java版有什麼差?

    Minecraft基岩版安裝模組(Add-On)&資源包&光影教學