MinecraftCodex 项目使用教程

MinecraftCodex 项目使用教程

MinecraftCodex OpenAI Codex demo using Minecraft GameTest API 项目地址: https://gitcode.com/gh_mirrors/mi/MinecraftCodex

1. 项目目录结构及介绍

MinecraftCodex 项目是一个开源项目，它使用 GPT-3 Codex 来驱动 Minecraft 中的非玩家角色（NPC）。以下是项目的目录结构及各部分功能的简要介绍：

MinecraftCodex/
├── .vscode/                    # Visual Studio Code 的配置文件
├── behavior_packs/             # 行为包文件夹，包含 NPC 行为代码
├── config/                     # 配置文件文件夹
├── scripts/                    # 脚本文件夹，包含启动和配置脚本
├── server/                     # 服务器配置和文件
├── worlds/                     # 世界数据文件夹
├── .eslintrc.js                # ESLint 配置文件
├── .gitattributes              # Git 属性配置文件
├── .gitignore                  # Git 忽略文件配置
├── .prettierrc.json            # Prettier 配置文件
├── CODE_OF_CONDUCT.md          # 项目行为准则
├── LICENSE                     # 项目许可证
├── README.md                   # 项目自述文件
├── SECURITY.md                 # 安全策略文件
├── SUPPORT.md                  # 支持信息文件
├── gulpfile.js                 # Gulp 配置文件
├── minecraft-codex.gif         # 项目示例图片
├── package-lock.json           # 包锁定文件
├── package.json                # 项目包文件
└── tsconfig.json               # TypeScript 配置文件

2. 项目的启动文件介绍

项目的启动主要通过 gulpfile.js 文件来管理。以下是主要的启动命令：

• npm install：安装项目所需的依赖包。
• gulp updateconfig：更新配置文件，以便模块能够进行网络请求。
• gulp updateserver：更新服务器配置属性。
• gulp updateworld：重置 Minecraft 专用服务器到默认的 Codex 世界。
• gulp serve：启动游戏服务器，加载配置和默认设置。
• gulp watch：监视文件变化，并在代码更改时重新编译。

3. 项目的配置文件介绍

项目的配置主要通过 config 文件夹下的文件进行管理。以下是主要的配置文件：

• vars.ts：包含项目全局变量的配置，如 OpenAI API 密钥、组织 ID 和模型 ID。
• server.properties：Minecraft Bedrock 专用服务器的配置文件，用于设置服务器属性。

在 vars.ts 文件中，你需要填写以下内容：

export let OPENAI_API_KEY = "<YOUR_KEY_HERE>";
export let OPENAI_ORGANIZATION_ID = "<YOUR_ORG_ID_HERE>";
export let OPENAI_ENGINE_ID = "<YOUR_CODEX_MODEL_NAME_HERE>";
export let DEBUG = false;

请确保将 <YOUR_KEY_HERE>、<YOUR_ORG_ID_HERE> 和 <YOUR_CODEX_MODEL_NAME_HERE> 替换为你的 OpenAI API 密钥、组织 ID 和模型 ID。

MinecraftCodex OpenAI Codex demo using Minecraft GameTest API 项目地址: https://gitcode.com/gh_mirrors/mi/MinecraftCodex