Installation zh TW - Akiaaaa20/Bit8_CLI GitHub Wiki

安裝 BIT8_CLI

English | 繁體中文 | 日本語 | 한국어

本頁說明如何安裝 BIT8_CLI 0.1.0、確認 CLI 是否正常運作，以及安裝選用的 VS Code Extension。

目前提供的預先建置平台：macOS ARM64 / Apple Silicon

系統需求

使用官方預先建置版本需要：

  • macOS
  • Apple Silicon Mac（M1 或更新）
  • Terminal
  • 如果要使用 BIT8_CLI VS Code Extension，則需要 VS Code

如果要從原始碼建置 BIT8_CLI，還需要安裝包含 Cargo 的 Rust toolchain。

下載 BIT8_CLI

開啟 BIT8_CLI 0.1.0 GitHub Release，下載：

BIT8-0.1.0-macos-arm64.zip

Release 另外提供：

bit8-vscode-0.1.0.vsix
BIT8-0.1.0-macos-arm64.sha256

.vsix 是可以單獨安裝的 VS Code Extension。

.sha256 可以用來驗證 Release 檔案。

GitHub 也會自動提供 Source code archives。這些是原始碼快照，和預先建置完成的 macOS ARM64 套件不同。

套件內容

解壓縮後：

BIT8-0.1.0-macos-arm64/
├── bin/
│   ├── bit8
│   └── bit8-language-server
├── vscode/
│   └── bit8-vscode-0.1.0.vsix
├── README.md
├── CHANGELOG.md
└── LICENSE

bit8 是 BIT8_CLI 的命令列執行檔。

bit8-language-server 提供開發環境所使用的 Language Service 功能。

vscode 目錄則包含 VS Code Extension 安裝套件。

執行 CLI

可以直接在解壓縮後的目錄測試：

./bin/bit8 --help

也可以確認版本：

./bin/bit8 --version

BIT8_CLI 0.1.0 應該顯示：

0.1.0

安裝 bit8 指令

如果希望不輸入完整路徑就能直接執行 bit8，可以把執行檔放進 PATH 包含的目錄。

例如可以使用個人的 binary 目錄：

~/.local/bin

加入 PATH 後確認：

bit8 --version

以及：

bit8 --help

如果 PATH 裡已經存在舊版 bit8，請確認 Shell 實際使用的是 0.1.0 執行檔。

可以使用：

which bit8

確認目前執行的是哪一個檔案。

安裝 VS Code Extension

Release 提供：

bit8-vscode-0.1.0.vsix

在 VS Code 中：

  1. 開啟 Extensions。
  2. 打開 Extensions 選單（...）。
  3. 選擇 Install from VSIX...
  4. 選擇 bit8-vscode-0.1.0.vsix。
  5. 如果 VS Code 要求重新載入視窗，執行 Reload。

Extension 提供 BIT8_CLI Language tooling、Map Workspace、Asset 工具、Node 編輯以及 BIT8 GAME。

從原始碼建置

如果已安裝 Rust 與 Cargo，可以 Clone BIT8_CLI repository，然後執行：

cargo install --path . --locked

開發期間也可以直接從 repository 執行：

cargo run -- run <project-path>

Language Service 與 VS Code Extension 位於 repository 中各自的專案目錄。

執行專案

當 bit8 指令可以使用後：

bit8 run <project-path>

例如：

bit8 run ./my-game

BIT8_CLI 專案通常使用：

main.b8

作為主要 Script。

Host Mode

Editor 與其他 Tooling 可以在不開啟原生遊戲視窗的情況下啟動 BIT8_CLI：

bit8 host <project-path>

Host Mode 透過 stdin / stdout 使用 NDJSON 與 Frontend 通訊。

一般使用者通常不需要直接操作 Host Mode。

疑難排解

出現 bit8: command not found

代表目前的 PATH 找不到 bit8 執行檔。

可以先使用完整路徑執行：

./bin/bit8 --help

或者把執行檔安裝到 PATH 包含的目錄。

執行到錯誤的 BIT8_CLI 版本

確認：

which bit8
bit8 --version

可能有較舊的 bit8 安裝位置排在 PATH 前面。

安裝後 VS Code 沒有出現 Extension

安裝或更換 VSIX 後，重新載入 VS Code 視窗。

下一步

繼續閱讀：

建立第一個專案

下一頁會建立一個最小的 BIT8_CLI 專案，並執行第一個 .b8 程式。