Minecraft Bot Control

🚀 MCPMC（Minecraft 模型上下文協議）

一個用於通過 Mineflayer 與 Minecraft 交互的模型上下文協議 (MCP) 服務器。此包能讓 AI 代理通過標準化的 JSON - RPC 接口控制 Minecraft 機器人，為 AI 與 Minecraft 的交互提供了便捷途徑。

🚀 快速開始

此包能讓 AI 代理藉助標準化的 JSON - RPC 接口控制 Minecraft 機器人，以下是使用前的安裝和啟動步驟。

✨ 主要特性

• 完全兼容 MCP，支持 AI 代理集成，為 AI 與 Minecraft 的交互提供了標準化的接口。
• 基於可靠的 Mineflayer 庫構建，確保系統的穩定性和可靠性。
• 支持導航、方塊操作、庫存管理等功能，滿足多樣化的遊戲操作需求。
• 即時遊戲狀態監控，讓用戶隨時瞭解遊戲的最新情況。
• 類型安全的 API 並附帶 TypeScript 支持，提高開發效率和代碼質量。

📦 安裝指南

你可以根據自己的需求選擇以下任意一種方式進行安裝：

# 使用 npm
npm install @gerred/mcpmc

# 使用 yarn
yarn add @gerred/mcpmc

# 使用 bun
bun add @gerred/mcpmc

💻 使用示例

基礎用法

啟動 MCP 服務器：

mcpmc

該服務器通過 stdin/stdout 使用模型上下文協議進行通信。

高級用法

若你需要查看詳細 API 文檔，請使用 MCP 檢查器：

bun run inspector

📚 詳細文檔

開發流程

# 安裝依賴項
bun install

# 運行測試
bun test

# 構建項目
bun run build

# 開發模式
bun run watch

# 運行 MCP 檢查器
bun run inspector

貢獻指南

歡迎貢獻！請按照以下步驟操作：

1. 叉出倉庫
2. 為你的功能創建新分支
3. 為你更改編寫測試
4. 進行更改
5. 運行測試並確保它們通過
6. 提交拉取請求

請務必更新相關測試，並遵守現有的編碼風格。

📄 許可證

本項目採用 MIT 許可證。

版權所有 (c) 2024 Gerred Dillon

特此授權，任何獲得本軟件及其關聯文檔文件副本的人（“軟件”），可以在不受限制的條件下使用、複製、修改、合併、發佈、分發、 sublicense 和/或出售 該軟件的副本，並允許向其提供該軟件的人按以下條件行事：

上述版權聲明和本許可聲明應包含在所有副本或實質性部分中。

軟件是“按原樣”提供的，不做任何形式的擔保，包括但不限於對適銷性、特定用途的適用性和非侵權性的明示或暗示保證。在因合同、侵權或其他行為導致的任何主張、損害或其他責任中，作者或版權持有人不承擔任何責任。

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.