Kaetram Open开发指南：如何搭建本地服务器并开始你的MMORPG二次开发

【免费下载链接】Kaetram-OpenKaetram is an open-source 2D HTML5 MMORPG. It is an extended version of BrowserQuest (BQ).项目地址: https://gitcode.com/gh_mirrors/ka/Kaetram-Open

Kaetram Open是一款基于HTML5技术的开源2D MMORPG游戏引擎，它扩展了经典BrowserQuest游戏的功能，为开发者提供了完整的二次开发框架。本文将详细介绍如何在本地搭建Kaetram服务器环境，让你快速开启个性化MMORPG游戏开发之旅。

📋 准备工作：开发环境搭建

核心依赖安装

在开始之前，请确保你的开发环境满足以下要求：

• Node.js：需要v16.17.1或更高版本（推荐LTS版本）
• MongoDB：可选，用于存储用户数据和游戏进度
• Yarn：通过Corepack启用的包管理器

安装Node.js后，通过以下命令启用Yarn：

corepack enable

获取项目源码

使用Git克隆官方仓库到本地：

git clone https://gitcode.com/gh_mirrors/ka/Kaetram-Open cd Kaetram-Open

⚙️ 快速安装与配置

安装项目依赖

在项目根目录执行以下命令安装所有依赖：

yarn

环境配置

1. 复制环境变量模板文件创建自定义配置：

cp .env.defaults .env

2. 编辑.env文件，至少需要设置以下关键选项：

ACCEPT_LICENSE=true # 必须设置为true以接受MPL2.0和OPL许可协议 SKIP_DATABASE=false # 若安装了MongoDB，设为false启用数据持久化 HUB_ENABLED=true # 启用跨服务器通信功能

🚀 启动开发服务器

开发模式运行

执行以下命令启动带热重载的开发服务器：

yarn dev

启动成功后，你可以通过http://localhost:3000访问游戏客户端，服务器默认运行在ws://localhost:3001。

图1：Kaetram游戏实际运行界面，展示了角色与NPC交互场景

生产环境构建

当开发完成后，使用以下命令构建生产版本：

yarn build yarn start

🎮 开始你的二次开发

了解项目结构

Kaetram采用Monorepo结构组织代码，核心模块位于packages/目录下：

• client/：游戏客户端代码，基于Astro框架和TypeScript
• server/：游戏服务器逻辑，包含实体系统和网络处理
• common/：共享类型定义和网络协议
• tools/：地图编辑器和资源处理工具

修改游戏内容

1. 编辑游戏地图

Kaetram使用Tiled Map Editor创建地图，地图数据位于：

packages/tools/map/data/map.json

修改后执行以下命令重新生成地图数据：

yarn map

图2：游戏地图tileset资源，包含各种地形和建筑元素

2. 添加新NPC或物品

• NPC数据：packages/server/data/npcs.json
• 物品配置：packages/server/data/items.json
• 自定义物品逻辑：packages/server/data/plugins/items/

3. 修改UI界面

游戏界面组件位于packages/client/src/menu/目录，你可以编辑SCSS样式文件自定义界面外观：

packages/client/scss/game/impl/

图3：角色界面UI设计，可通过修改对应SCSS文件自定义样式

🔧 高级配置选项

数据库设置

若启用MongoDB，需在.env中配置数据库连接信息：

MONGODB_URI=mongodb://localhost:27017/kaetram MONGODB_AUTH=false MONGODB_USER= MONGODB_PASS=

多服务器部署

通过配置Hub系统实现多服务器部署：

HUB_PORT=3002 API_PORT=3003 SERVERS=[{"id": "server1", "name": "Main", "port": 3001}]

📚 开发资源

• 官方文档：项目根目录的README.md
• 网络协议：packages/common/network/opcodes.ts
• 地图工具：packages/tools/map/
• 测试用例：packages/e2e/cypress/

📝 许可证说明

Kaetram Open采用MPL-2.0许可证，二次开发时需遵守以下要求：

• 保留原始 credits 信息
• 代码必须保持开源
• 不得用于AI、加密货币或NFT相关项目

通过以上步骤，你已经成功搭建了Kaetram Open的本地开发环境。现在可以开始创建自己的游戏世界，添加独特的游戏机制和内容了！如有疑问，可查阅项目文档或加入社区讨论获取支持。

【免费下载链接】Kaetram-OpenKaetram is an open-source 2D HTML5 MMORPG. It is an extended version of BrowserQuest (BQ).项目地址: https://gitcode.com/gh_mirrors/ka/Kaetram-Open