• README - English
• github link
• gitee link

luban是你的最佳游戏配置解决方案。

luban高效地处理游戏开发中常见的excel、json、xml之类的数据，检查数据错误，生成c#等各种语言的代码，导出成bytes或json等多种格式。

luban统一了游戏配置开发工作流，极大提升了策划和程序的工作效率。

• 强大的数据解析和转换能力 {excel(csv,xls,xlsx), json, bson, xml, yaml, lua, unity ScriptableObject} => {binary, json, bson, xml, lua, yaml, erlang}
• 支持生成c#,java,go,c++,lua,python,javascript,typescript,erlang,rust代码
• 增强的excel格式，可以简洁地配置出像简单列表、子结构、结构列表，以及任意复杂的深层次的嵌套结构。
• 支持json、lua、xml等格式的数据来表达行为树、技能、剧情、副本之类复杂GamePlay数据
• 支持生成 protobuf(schema + binary + json)、flatbuffers(schema + json)、msgpack(binary)
• 强大的数据校验能力。ref引用检查，path资源路径检查等等。
• 支持unity、unreal、cocos2x、微信小游戏等主流引擎及 win、linux、mac等平台。
• 支持xLua、toLua、ILRuntime、Puerts、unLua、sLuaUnreal、XIL等等主流热更新方案
• 支持skynet、ET、GameFramework、QFramework、xlua-famework、KSFramework等第三方框架
• 完善的本地化支持。
• 强大灵活的自定义能力，支持代码模板和数据模板
• ==通用型生成和缓存工具==。也可以用于生成协议、数据库之类的代码，甚至可以用作对象缓存服务。

完整特性请参见 feature

• 快速上手

• Document ，比较完善，有使用疑问，请先查看此文档。

• 示例项目 (github) (gitee)

• 版本变更记录

• 支持与联系

  • QQ群: 692890842 （Luban开发交流群）。有使用方面的疑问请及时加QQ群询问，随时有人帮助解决。
  • 邮箱: taojingjian#gmail.com

完整示例请详见 excel格式介绍

多个key构成联合唯一主键。

多个key独立索引。

有一些配置全局只有一份，比如 公会模块的开启等级，背包初始大小，背包上限。此时使用单例表来配置这些数据比较合适。

以行为树为例，展示json格式下如何配置行为树配置。xml、lua、yaml等等格式请参见 详细文档。

{
  "id": 10002,
  "name": "random move",
  "desc": "demo behaviour tree",
  "executor": "SERVER",
  "blackboard_id": "demo",
  "root": {
    "__type__": "Sequence",
    "id": 1,
    "node_name": "test",
    "desc": "root",
    "services": [],
    "decorators": [
      {
        "__type__": "UeLoop",
        "id": 3,
        "node_name": "",
        "flow_abort_mode": "SELF",
        "num_loops": 0,
        "infinite_loop": true,
        "infinite_loop_timeout_time": -1
      }
    ],
    "children": [
      {
        "__type__": "UeWait",
        "id": 30,
        "node_name": "",
        "ignore_restart_self": false,
        "wait_time": 1,
        "random_deviation": 0.5,
        "services": [],
        "decorators": []
      },
      {
        "__type__": "MoveToRandomLocation",
        "id": 75,
        "node_name": "",
        "ignore_restart_self": false,
        "origin_position_key": "x5",
        "radius": 30,
        "services": [],
        "decorators": []
      }
    ]
  }
}

这儿只简略展示c#、typescript、go语言在开发中的用法，更多语言以及更详细的使用范例和代码见示例项目。

• C# 使用示例

// 一行代码可以加载所有配置。 cfg.Tables 包含所有表的一个实例字段。
var tables = new cfg.Tables(file => return new ByteBuf(File.ReadAllBytes(gameConfDir + "/" + file + ".bytes")));
// 访问一个单例表
Console.WriteLine(tables.TbGlobal.Name);
// 访问普通的 key-value 表
Console.WriteLine(tables.TbItem.Get(12).Name);
// 支持 operator []用法
Console.WriteLine(tables.TbMail[1001].Desc);

• typescript 使用示例

// 一行代码可以加载所有配置。 cfg.Tables 包含所有表的一个实例字段。
let tables = new cfg.Tables(f => JsHelpers.LoadFromFile(gameConfDir, f))
// 访问一个单例表
console.log(tables.TbGlobal.name)
// 访问普通的 key-value 表
console.log(tables.TbItem.get(12).Name)

• go 使用示例

// 一行代码可以加载所有配置。 cfg.Tables 包含所有表的一个实例字段。
if tables , err := cfg.NewTables(loader) ; err != nil {
 println(err.Error())
 return
}
// 访问一个单例表
println(tables.TbGlobal.Name)
// 访问普通的 key-value 表
println(tables.TbItem.Get(12).Name)

• 新增 unity 内置编辑器
• 新增 unreal 内置编辑器
• 补充单元测试

Luban is licensed under the MIT license.