跳到正文
本頁目錄

快速開始

本指南將幫助你快速上手 lip,涵蓋項目中管理包的基礎用法。

前置條件

開始前請確保你已安裝 lip。lip 不需要安裝 git。

在界面中設置服務器

最簡單的方式:打開終端,運行 lip。界面的主頁列出三個步驟:創建服務器、安裝模組、啟動服務器。用方向鍵選擇一步並按 Enter。第一步中,你在文件夾瀏覽器中選擇服務器的文件夾,然後選擇遊戲版本(列表會標明 LeviLamina 是否支持它)和加載器;lip 會顯示將要安裝的內容,並請你接受 Minecraft EULA。參見交互界面。

如果你的網絡連不上 GitHub,界面還會詢問是設置 GitHub 代理、仍然直接連接,還是稍後再決定。參見 GitHub 代理。

設置服務器

如果要改用命令行設置,在服務端的根目錄(即工作區,例如一個新的空目錄)中運行 lip。首先設置服務器:某個遊戲版本的 Bedrock Dedicated Server,以 LeviLamina 為加載器:

shell
lip setup --game 1.21.0

這會安裝支持遊戲 1.21.0 的最新 LeviLamina。如果想改用 LeviLamina 支持的最新遊戲,請安裝 LeviLamina:

shell
lip install LeviLamina

在下載遊戲之前,lip 會給出 Minecraft 最終用戶許可協議和 Microsoft 隱私聲明的鏈接,並詢問你是否接受:輸入 yes。在腳本中 lip 無法詢問,請加上 --accept-eula。參見 lip setup。

安裝包

使用 install 命令並跟上包 ID 即可安裝包(例如 mod),也可用 @ 指定版本,例如 github.com/LiteLDev/LegacyScriptEngine#lua@1.0.0。

shell
lip install github.com/LiteLDev/LegacyScriptEngine#lua

mod 需要服務器:在還沒有遊戲的工作區中,lip install 安裝 mod 會失敗,並請你先運行 lip setup。

lip 支持從多種來源安裝(包括 Git 倉庫、URL,以及磁盤上的 ZIP 文件和目錄)。安裝時會:

  • 下載到本地緩存;
  • 解析並安裝其依賴;
  • 記錄到狀態文件(工作區中的 .lip/state.json)中。你的 lip.toml 不會被修改。

lip 只管理服務端工作區。客戶端 mod 由 LeviLauncher 等啟動器管理。

在任何系統上,lip 都安裝平臺 win-x64 的包。在 Linux 和 macOS 上,它通過 Wine 運行這些包的鉤子命令和服務器。不帶 LeviLamina 的 Linux 版服務器用 lip setup --game <version> --build linux 設置,lip run 在 x64 的 Linux 上啟動它。參見運行服務器。

運行服務器

設置好服務器之後,在工作區中啟動它:

shell
lip run

像平常一樣輸入服務器命令即可。按 Ctrl+C 停止服務器:lip 向它發送 stop,並在它退出後退出。服務器運行期間,你可以在另一個終端中安裝和更新包;這些改動在服務器下次啟動時生效。界面不會改動服務器正在運行的工作區中的包:請先停止服務器(見服務器運行期間)。

查看已安裝包

查看當前項目中已安裝的所有包:

shell
lip list

會顯示包列表及其已安裝版本。

查看包信息

你可以在不安裝的情況下,以 JSON 形式獲取包的包文件及其可用版本:

shell
lip pkg view github.com/LiteLDev/LeviLamina

更新包

使用 update 命令將包更新到新版本。

shell
lip update github.com/LiteLDev/LegacyScriptEngine#lua

如需切換到某個特定版本(包括更舊的版本),請用 @ 指定,例如 lip update github.com/LiteLDev/LegacyScriptEngine#lua@1.0.0。這會把該包固定在該版本,直到你用不帶 @ 的路徑更新它。不帶參數運行 lip update 會更新所有你顯式安裝的包,遊戲和 LeviLamina 除外:如需改變它們的版本,請再次運行 lip setup,例如 lip setup --game 1.21.50。

卸載包

從項目中移除包及其安裝的文件:

shell
lip uninstall github.com/LiteLDev/LegacyScriptEngine#lua

配置

lip 支持配置全局設置,例如代理。

查看當前配置:

shell
lip config list

設置配置項:

shell
lip config set github_proxy https://mirror.ghproxy.com/

創建包

如果你要創建 mod 或其他包,請先初始化其 lip.toml。在項目根目錄運行:

shell
lip pkg init

該命令會詢問你的包的包 ID(例如 github.com/user/MyMod),並在當前目錄創建 lip.toml 文件(若已存在則失敗)。這個文件向 lip 描述你的包。如果只是安裝包,則不需要它。參見創建包。

下一步

  • 查看 CLI 概覽 瞭解更多高級命令用法。
  • 查看 lip.toml 瞭解結構細節。