用 lip 發佈你的模組
完成本教程後,你的模組會在 GitHub 上有第一個發佈版本,任何人都能用一條命令 lip install github.com/<you>/my-mod 把它裝到自己的服務器上。你將在 lip.toml 中描述模組,讓 GitHub Actions 構建發佈版本,確認 lip 能看到它,在自己的服務器上安裝它,並讓它上架 LeviMC 模組。
大約需要半小時,大部分時間在等待發布構建。
你需要準備
- 一個由模組模板創建、能夠構建的公開 GitHub 倉庫中的模組:見你的第一個 LeviLamina 模組。本教程把倉庫稱為
github.com/<you>/my-mod。 lip和一個用於測試的服務器:見開你的第一個服務器。本教程使用D:\servers\survival。- 已登錄 GitHub、可以推送的 Git。
需要 lip 0.41
本教程的 lip pkg … 命令隨 lip 0.41 提供,在正式版發佈前它還是預發佈版本(lip 0.40 沒有這些命令)。用 lip -v 檢查版本,需要時從 lip 的發佈頁安裝最新的 0.41。
包是 lip 能安裝的任何東西。它的包 ID 是倉庫地址去掉 https://:github.com/<you>/my-mod。一個版本就是一個名為 v 加版本號的 Git 標籤,例如 v0.1.0,並且該標籤處的 lip.toml 寫著同樣的版本。沒有上傳這一步:發佈就是推送這個標籤。
1. 填寫 lip.toml
模板自帶一個 lip.toml,它告訴 lip 要安裝什麼。打開它,修改下面這些字段,其餘保持不變。
format = 4
id = "github.com/<you>/my-mod" # 包 ID:你的仓库
version = "0.1.0" # 即将发布的版本,不带 "v"
[info] # 显示在 LeviMC 模组和 LeviLauncher 中;lip 忽略它
name = "My Mod"
description = "Says hello."
tags = ["utility"]
logo = "https://avatars.githubusercontent.com/u/<your user id>"然後,在兩個 [[variants.""]] 條目中(一個是 side = "server",一個是 side = "client"):
- 在
deps中設置模組適用的 LeviLamina 版本範圍。服務端條目使用"26.60.*"這樣的範圍,與你在xmake.lua中固定的版本一致。客戶端範圍請保留其註釋和寫法。 - 在
urls中,把levilamina-mod-template換成你的倉庫名:發佈工作流上傳的是<仓库名>-server-windows-x64.zip和<仓库名>-client-windows-x64.zip。 - 在
place中,把src和dest裡的my-mod換成xmake.lua中的 target 名:每個 ZIP 文件裡都有文件夾<target>/,它會被放到mods/<target>/。
如果你的模組只用於服務端,請刪除整個客戶端條目:即 side = "client" 的 [[variants.""]] 以及它下面的 deps 和 assets。
{{id}} 和 {{version}}
lip.toml 中的每個字符串都是模板。{{version}} 會變成上面的 version,所以新的發佈只需要修改 version。{{id}} 會變成包 ID。
沒有 lip.toml 或只有 tooth.json 的倉庫
對於不是由模板創建的倉庫,在其根目錄運行 lip pkg init:它會詢問包 ID,並寫入一個最小的 lip.toml,再按上面的方式填寫。lip v0.x 的 tooth.json 用 lip pkg migrate 轉換;見遷移包。
2. 確認 lip 能讀取它
在倉庫文件夾中運行:
lip pkg view .你應該看到一段 JSON:manifest 下是你的 id 和 version,以及已填好模板的 urls,例如 https://github.com/<you>/my-mod/releases/download/v0.1.0/my-mod-server-windows-x64.zip。檢查這些名字與你的倉庫一致。如果文件有錯,lip 會告訴你哪裡不對。
3. 編寫更新日誌
發佈工作流會把 CHANGELOG.md 中最新的一節複製到發佈說明中。按 Keep a Changelog 的格式為這個版本添加一節:
## [0.1.0] - 2026-11-16
### Added
- The `/hello` command.提交併推送所有改動:
git add -A
git commit -m "Release 0.1.0"
git push4. 創建發佈版本
- 在 GitHub 上你的倉庫頁面中,打開 Releases → Draft a new release。
- 在 Choose a tag 中輸入
v0.1.0,選擇 Create new tag: v0.1.0 on publish。目標是默認分支,也就是你剛推送的提交。 - 給發佈起個標題,例如
0.1.0,然後點擊 Publish release。 - 打開 Actions 標籤頁。發佈觸發了一次工作流運行:它構建服務端和客戶端模組,然後上傳。等到它出現綠色對勾(幾分鐘)。
- 再次打開這個發佈。你應該在 Assets 下看到兩個文件:
my-mod-server-windows-x64.zip和my-mod-client-windows-x64.zip,發佈說明是你的更新日誌。
標籤必須與 version 一致
標籤是 v 加完整的語義化版本:v0.1.0,而不是 0.1.0 或 v0.1。在標籤 v0.1.0 處,lip.toml 必須寫著 version = "0.1.0",否則 lip、LeviMC 模組和 LeviLauncher 都會跳過這個標籤。
5. 確認 lip 能看到這個版本
在任意文件夾中運行:
lip pkg view github.com/<you>/my-mod你應該在末尾看到 "versions": ["0.1.0"],manifest 下是你打標籤的那個 lip.toml。
6. 像用戶一樣安裝它
-
停止服務器。如果上一個教程留下的
mods\my-mod還在,請刪除這個文件夾,確保你測試的只是lip安裝的內容。 -
在服務器文件夾中安裝你的包:
shellcd D:\servers\survival lip install github.com/<you>/my-mod lip listlip list應該顯示github.com/<you>/my-mod@0.1.0。 -
啟動服務器。你應該再次看到
Hello from my first mod!,這次來自lip下載的文件。
模組上架後(第 7 步),玩家可以用 LeviLauncher 安裝同一個包的客戶端構建:見在 Windows 上玩模組。
7. 上架 LeviMC 模組
LeviMC 模組是 lip 的「獲取模組」頁和 LeviLauncher 顯示的目錄。它由一份倉庫列表構建,即 levimc.org 倉庫中的 mods/repos.txt。
通常你什麼都不用做:每兩小時會有一個機器人在 GitHub 上搜索帶有 lip.toml 和 lip 能讀取的版本標籤的倉庫,併發起拉取請求把它們加入列表。維護者合併後,模組會在下一次每小時構建中出現。
想更快上架,可以自己發起這個拉取請求:在 GitHub 上編輯 mods/repos.txt,添加一行 <you>/my-mod。
目錄收錄一個包的條件是:
- 它的最新版本依賴 LeviLamina,直接依賴或通過其他包依賴均可;
- 它把文件放到
mods/(或plugins/,或遊戲加載附加包的位置); - 倉庫不是 GitHub 模板,名字也不以
-template、-example、-demo、-sample或-test結尾。
之後你應該能在 https://levimc.org/zh-Hans/mods/github.com/<you>/my-mod/ 找到你的模組,頁面上有它的名字、描述、圖標、標籤和安裝命令。
發佈下一個版本
- 把
lip.toml中的version改高,例如0.2.0,並在CHANGELOG.md中添加對應的一節。提交併推送。 - 按第 4 步創建發佈
v0.2.0。 - 在服務器上,
lip update github.com/<you>/my-mod會安裝新版本。
你現在有了什麼
- 你的模組在 GitHub 上的一個發佈版本,由 GitHub Actions 構建。
- 一個可以用
lip install github.com/<you>/my-mod安裝的包,帶有對 LeviLamina 的依賴。 - 列表收錄後,你的模組會出現在 LeviMC 模組上。
下一步
lip.toml的所有字段:依賴、變體、要保留或刪除的文件、鉤子:lip.toml。- 包作者使用的命令:
lip pkg init、lip pkg pack、lip pkg view、lip pkg migrate。 - 在發佈前安裝某個分支或提交:管理包。
lip界面中的同類工具:工具。- 服務器如何安裝你的包:給服務器安裝模組。