License: MIT

Xavier 的 dota2 自定义游戏开发模板

简单的视频教程(中文) a starter video tutorial (Chinese)

1. 点击使用本项目作为模板生成你自己的项目或者 fork 本项目
2. 安装 node.js
3. 使用 git clone 你自己的项目
4. 安装好 vscode,使用vscode打开clone的文件夹
5. 打开 scripts/addon.config.ts,将 addon_name 修改为你想要使用的项目名称
6. 执行 yarn install安装依赖
7. 执行 yarn dev 开始你的开发
8. 你可以使用指令yarn launch map_name 快速启动测试,或者使用 yarn launch 指令只启动工具

1. 可以使用更为现代的语言(typescript)来进行开发,且前后端均使用 typescript 开发
2. 使用表格工具来填写并管理你的 kv 文件
3. 使用react来开发UI可以更好地管理你的代码,而无需掌握xml的写法。
4. 帮助解决了V社的工具中诸如UI无法读取KV文件,UI图片不会自动编译等问题。
5. 加密发布代码的支持,可以帮助你保护一些关键代码。
6. 新增了火焰图性能分析工具支持,请查看 火焰图性能分析模块使用说明。

1. 前端的content/panorama/src与后端的game/scripts/src文件夹分别用来写用户界面 react 源码和游戏逻辑的 ts 源代码
2. 将你的 excel 文件变成 kv 文件并放到game/scripts/npc文件夹,同时在panorama和scripts文件夹生成与每个kv文件对应的json文件,这样你的ts代码可以很方便地获取kv数据
3. 将 addon.csv 变成 addon_*.txt,(也可以把 addon_*.txt 变成 addon.csv)
4. 将服务器API转换为typescript接口,同时提供了一个有效的请求类用来处理请求,使用的是 openapi-typescript-codegen

1. 推荐使用yarn launch [[addon_name] map_name]直接启动项目进行开发
2. yarn dev 进入 dev 模式,将会执行编译操作,在开发时请保持编译状态
3. yarn prod 执行发布或者加密发布操作
4. yarn api 生成与 scripts/server_api.json (需要符合Swagger 3.0规范)的API一致的请求类,并储存于 game/scripts/src/server/services,关于请求实现的细节,请查阅 game/scripts/src/server/core 文件夹

• content 会和 dota 2 beta/content/dota_addons/your_addon_name 同步更新
• game 会和 dota 2 beta/game/dota_addons/your_addon_name 同步更新
• shared 用来写panorama ts和tstl公用的声明,如custom_net_tables等
• scripts 各种 node 脚本,用来完成各种辅助功能
• 请仔细查阅 gulpfile.ts 来查看 gulp 的使用方法

• node.js, LuaForWindows , Python 等一系列环境的配置请自行使用搜索引擎完成,不赘述。
• 只推荐使用steam启动dota2的形式来完成modding,如果尚未安装,请点此下载

1. 代码编辑器 Visual Studio Code 或者其他你习惯使用的typescript代码编辑器
2. 反编译工具 ValveResourceFormat(推荐)或者 GCFScape(已略过时,某些格式反编译不了,但是速度比较快,推荐都安装)
3. Adobe系列工具, 如PhotoShop(必须), Audition(选装)等,请到 官网 下载或自行使用搜索引擎获取
4. 代码版本控制 Github Desktop(推荐,和github的配合比较好) 或 SourceTree 或 TortoiseSVN
5. 模型编辑器Blender Steam直接安装【steam://install/365670】 Steam商店页面 (用自己顺手的就行,如果不涉及模型编辑可略过)
6. 其他实用工具: 文件搜索工具Everything Deepl翻译 Node版本控制nvm-windows

• 执行 yarn install 出现权限问题报错怎么办?
  • 请尝试关闭代码编辑器后,使用控制台来执行yarn install,或者重启一下电脑再试
• 因为网络问题导致安装错误怎么办?
  • 可以尝试使用npmmirror镜像,或者直接执行yarn config set registry https://registry.npmmirror.com再执行yarn install
• 如何在保持 yarn dev 状态下再执行其他指令?
  • 在 vscode 中,你可以使用ctrl+shift+5来同时打开多个terminal终端
• 如何获取加密所需的秘钥?
  • 你可以使用本项目提供的 Debug 代码指令,先不加密上传,使用 get_key_v3 [version] 指令获取秘钥,之后再加密上传覆盖,具体的实现请 查阅代码
• 有没有相关的教程?
  • TODO:制作相关教程

• 如果你在DOTA2自定义游戏制作过程中遇到了任何问题,可以到本项目的 Issues页面 提问,如果我知道的将会予以解答。
• 代码写累了也可以玩玩 dota,你可以使用 yarn launch do 启动正常(非工具模式的dota2),也可以使用 yarn launch dop 来启动带 -perfectworld 参数的dota2