From bfea820c7c9afda8c6e56c7aaabf0505c3da974b Mon Sep 17 00:00:00 2001 From: walon Date: Wed, 21 Oct 2020 21:50:21 +0800 Subject: [PATCH] modify README --- README.en-us.md | 8 ++++---- README.md | 36 +++++++++++++++++------------------- 2 files changed, 21 insertions(+), 23 deletions(-) diff --git a/README.en-us.md b/README.en-us.md index 5a72d76..780bbd4 100644 --- a/README.en-us.md +++ b/README.en-us.md @@ -1,6 +1,6 @@ -# Birght Gen +# Luban -## What is Bright Gen +## What is Luban * Aim * Less time for trival & repeated work, more time with creativity & leisure . @@ -8,7 +8,7 @@ * Philosophy * Simpler, Faster -* [Home Page](https://focus-creative-games.github.io/bright_gen/index.html) +* [Home Page](https://focus-creative-games.github.io/luban/index.html) * Read this in other languages: [English](README.en-us.md), [简体中文](README.md) @@ -59,4 +59,4 @@ We welcome contributions! Many people all over the world have helped make this p ## License -Birght Gen is licensed under the [MIT](LICENSE.TXT) license. \ No newline at end of file +Luban is licensed under the [MIT](LICENSE.TXT) license. \ No newline at end of file diff --git a/README.md b/README.md index caf5654..0bbe712 100644 --- a/README.md +++ b/README.md @@ -1,28 +1,21 @@ [//]: # (Author: bug) [//]: # (Date: 2020-10-20 20:24:07) -# Gen +# Luban -## 什么是 Gen +## 什么是 Luban -Gen 是一个强大的生成与缓存工具，用于但不限于 游戏配置、消息、资源格式转换 之类的生成。 +Luban 是一个强大的生成与缓存工具，用于但不限于 游戏配置、消息、资源格式转换 之类的用途。 -相比传统简单的以excel为中心的表格导出工具，它提供了一个**完整的游戏配置数据解决方案**，有以下功能： -> -> * 数据定义 -> * 数据编辑 -> * 数据导出 -> * 前后端代码生成 -> * 本地化 -> * 编辑器数据load&save代码生成 +相比传统简单的以excel为中心的表格导出工具，它提供了一个**完整的游戏配置数据解决方案**。 -Gen能够良好满足小型、中型、大型及超大型游戏项目的配置需求。 +Luban 能够良好满足小型、中型、大型及超大型游戏项目的配置需求。 -Gen 工具不仅适用于游戏行业，也非常适合传统的互联网项目。 +Luban 工具不仅适用于游戏行业，也非常适合传统的互联网项目。 ## 文档 -* [主页](https://focus-creative-games.github.io/bright_gen/index.html) +* [主页](https://focus-creative-games.github.io/luban/index.html) * 各语言的简介: [English](README.en-us.md), [简体中文](README.md) ## 使用示例 @@ -32,7 +25,14 @@ Gen 工具不仅适用于游戏行业，也非常适合传统的互联网项目 local cfg = data[32] print(cfg.name) ``` - + + * C# 使用示例 + ``` C# + var tables = new cfg.Tables(file => return new ByteBuf(File.ReadAllBytes("output_data/" + file))); + Console.WriteLine(tables.TbSingleton.Name); + Console.WriteLine(tables.TbDataFromJson.Get(12).X1); + Console.WriteLine(tables.TbTwoKey.Get(1, 10).X8); + ``` * [更多语言的例子](docs/samples.md) ## 特性 @@ -42,7 +42,6 @@ Gen 工具不仅适用于游戏行业，也非常适合传统的互联网项目 * [按组导出数据](docs/feature.md#如何自定义导出分组) * [生成速度快](docs/feature.md#生成极快) * [增强 Excel 的表达](docs/feature.md#增强的-excel-格式) - * [代码提示支持](docs/feature.md#代码编辑器支持) * [根据开发效率需求定制的数据输出格式](docs/feature.md#支持多种导出数据格式) * [本地化支持](docs/feature.md#本地化支持) * [代码提示支持](docs/feature.md#代码编辑器支持) @@ -59,8 +58,7 @@ Gen 工具不仅适用于游戏行业，也非常适合传统的互联网项目 ## RoadMap - [ ] 新增 unity 内置编辑器 - [ ] 新增 unreal 内置编辑器 -- [ ] 补充单元测试 -- [x] 支持 python +- [ ] 补充单元测试 ## 布署 TODO @@ -85,4 +83,4 @@ Gen 工具不仅适用于游戏行业，也非常适合传统的互联网项目 ## License -Birght Gen is licensed under the [MIT](LICENSE.TXT) license. \ No newline at end of file +Luban is licensed under the [MIT](LICENSE.TXT) license. \ No newline at end of file