自製PocketMine插件入門: 自訂指令 & 歡迎訊息

 PocketMine的插件(plugin)是用世界上最好的語言PHP寫成的。

(PocketMine開伺服器教學)

以下教學在Windows做一個自訂指令的PM插件,並放到伺服器上測試。



    安裝必要軟體

    如果只是單純寫php,不需要安裝這些有的沒的,手機也可以寫,但安裝這些工具可以方便除錯。

    1. 安裝Windows版本的PHP,下載之後解壓縮,放到C槽的ProgramFiles。
    設定環境變數,Path指向PHP資料夾。

    2.本篇教學使用VSCode編輯器,安裝"PHP Debug"和"PHP Intelephense"這二個熱門延伸模組後重啟VSCode。

    3. 從Github下載PocketMine原始碼,解壓縮,然後安裝VSCode上的PocketMine IDE延伸模組,開啟這個延伸模組的設定值,填入src資料夾的位置,例如"C:\\Program Files\\PocketMine-MP-stable\\src" (有引號)

    4. 下載Development Tools for PocketMine-MP,把這個插件放到伺服器的plugins資料夾,以插件形式安裝。


    專案結構

    插件的資料夾結構應該長這樣,頂層目錄是"MyPlugin":
    MyPlugin
    │  plugin.yml
    └─src
        └─examplePlugin
                Main.php

    src裡面的exmplePlugin資料夾可以自訂名字,而主程式就是Main.php。


    首先編輯"plugin.yml",填入以下內容:
    name是這個插件的名字,不要有空白。
    main所指的就是主程式位置(不需附檔名),記得要跟src/資料夾下的一致。
    permission是權限,預設是所有玩家都可以使用。
    此外,有使用到自訂指令的話,也可以在這裡註明,例如這裡有一個叫做"getsteak"的指令。

    插件程式碼

    在Main.php輸入以下內容:

    測試插件

    還不需要打包成phar,直接將專案資料夾複製到伺服器根目錄/plugins/下,接著啟動伺服器,就會有插件載入提示。


    加入世界,除了預設的黃色提示訊息,多了綠色的歡迎訊息。


    使用指令/getsteak 數字,出現提示。



    確認可以獲得牛排。



    打包插件成.phar檔

    插件以資料夾型態載入時可邊修改邊測試,但為避免影響到伺服器/plugins下的其他檔案,建議還是把開發中的專案分開放。
    最後,可利用PocketMine DevTools將資料夾打包成.phar,上傳到Poggit官方儲存庫給別人使用。

    1. 將要打包的插件資料夾放到伺服器根目錄/plugins/


    2. 啟動伺服器,確認PocketMine DevTool和你的插件都有成功載入。
    終端機輸入"makeplugin 插件名字",例如"makeplugin MyPlugin",插件的名字需與plugin.yml裡面所寫的一致,不要有空格。


    3. 接著就會產生.phar檔案,位於根目錄/plugin_data/DevTools/裡面。以後把這個檔案直接放在/plugins資料夾就能載入插件。

    參考資料

    留言

    此網誌的熱門文章

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

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

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