diff --git a/README.md b/README.md index 39de4f3..712dcef 100644 --- a/README.md +++ b/README.md @@ -40,11 +40,11 @@ Luban适合有以下需求的开发者: - [主页](https://focus-creative-games.github.io/luban/index.html) - [特性](docs/traits.md) - [Excel 配置数据简介](docs/data_excel.md) -- [使用说明](docs/catalog.md) +- [文档目录](docs/catalog.md) - [常见问题](docs/faq.md) -- [快速上手及进阶](docs/start_up.md) -- [完整手册](docs/manual.md) -- [示例项目](https://github.com/focus-creative-games/luban_examples) +- [[TODO] 快速上手及进阶](docs/start_up.md) +- [[TODO] 完整手册](docs/manual.md) +- **[====>强烈推荐查看:示例项目 <====](https://github.com/focus-creative-games/luban_examples)** ## 特性 - 支持增强的excel格式,可以在excel里比较简洁填写出任意复杂的数据 @@ -111,7 +111,8 @@ Luban适合有以下需求的开发者: - + + 本地化字符串,由key和text两个字段构成 @@ -790,7 +791,9 @@ return ## 使用 luban-client - 基于 docker (推荐 linux、mac平台使用) - docker run --rm focuscreativegames/luban-client <参数> + docker run --rm -v $PWD/.cache.meta:/bin/.cache.meta focuscreativegames/luban-client <参数> + + 提醒! .cache.meta这个文件用于保存本地生成或者提交到远程的文件md5缓存,**强烈推荐** 添加-v 映射,不然每次重新计算所有涉及文件的md5,这可能在项目后期会造成多达几秒的延迟。 - 基于 .net 5 runtime (推荐win平台使用,可跨平台,不需要重新编译) - 自行安装 .net 5 runtime. - 从[示例项目](https://github.com/focus-creative-games/luban_examples/tree/main/Tools/Luban.Client)拷贝 Luban.Client(**可跨平台,即使在linux、mac平台也不需要重新编译**) diff --git a/docs/catalog.md b/docs/catalog.md index f41a4bc..9ece113 100644 --- a/docs/catalog.md +++ b/docs/catalog.md @@ -1,7 +1,7 @@ * start up - - [下载 dotnet sdk 3.1](https://dotnet.microsoft.com/download/dotnet-core/3.1) - - [下载 luban.client&luban.server](https://github.com/focus-creative-games/luban/releases/tag/v1.0) + - [下载 dotnet 5](https://dotnet.microsoft.com/download/dotnet/5.0) + - [下载 luban.client&luban.server](https://github.com/focus-creative-games/luban_examples/tree/main/Tools) - 启动 luban.server - 创建游戏配置 - root.xml diff --git a/docs/images/examples/ex_2.png b/docs/images/examples/ex_2.png index 826def4..3d52e5a 100644 Binary files a/docs/images/examples/ex_2.png and b/docs/images/examples/ex_2.png differ diff --git a/docs/traits.md b/docs/traits.md index b9dd402..586db26 100644 --- a/docs/traits.md +++ b/docs/traits.md @@ -13,6 +13,9 @@ - bool?,byte?,short?,fshort?,int?,fint?,long?,flong?,float?,double? - vector2?,vector3?,vector4? - datetime? + - <枚举>? + - < bean>? + - <多态bean>? * 自定义枚举 enum 及相应可空类型 * 自定义常量 const * 自定义结构 bean @@ -84,7 +87,6 @@ ### 多种数据表模式 * one 格式,即单例表模式 * map 格式,即普通key-value表模式。 任何符合set 的value要求的类型都可以做key -* bmap 格式,即双主键模式。 任何符合 set 的value要求的类型都可以作 key1和key ### 本地化支持 * 支持**本地化时间**。 配置中的 datetime会根据指定的timezone及localtime转化为正确的utc时间,方便程序处理