doc[zfoo]: update doc

This commit is contained in:
godotg committed 2023-09-22 21:47:03 +08:00
1 parent 280c4d634c
commit d2a7c4fda5
4 files changed
+36 -37

No files matched your search

+15 -16
View File
@@ -5,7 +5,8 @@ English | [简体中文](./README_CN.md)
----------- -----------
- **Extremely fast, asynchronous, Actor design pattern, lock-free design, RPC framework, GraalVM native support** - **Extremely fast, asynchronous, Actor design pattern, lock-free design, RPC framework, GraalVM native support**
- **Ultimate performance serialization and deserialization [zfoo protocol](protocol/README.md)**,supports C++ C# Go Java Javascript TypeScript Lua GDScript Python - **Ultimate performance serialization and deserialization [zfoo protocol](protocol/README.md)**,supports C++ C# Go Java
Javascript TypeScript Lua GDScript Python
- **High scalability**,Single server deployment, microservice deployment, cluster deployment, gateway deployment - **High scalability**,Single server deployment, microservice deployment, cluster deployment, gateway deployment
- **Can be used as a game server framework or website server framework.** - **Can be used as a game server framework or website server framework.**
@@ -30,21 +31,7 @@ Perfect work development process, complete online solution
- As a backend infrastructure for **Godot,Unity,Cocos,Webgl,H5**,Network protocol supports tcp udp websocket http - As a backend infrastructure for **Godot,Unity,Cocos,Webgl,H5**,Network protocol supports tcp udp websocket http
- [Keep it Simple and Stupid](https://baike.baidu.com/item/KISS原则/3242383) ,simple configuration, lightweight code - [Keep it Simple and Stupid](https://baike.baidu.com/item/KISS原则/3242383) ,simple configuration, lightweight code
Ⅲ. Tutorials Ⅲ. Maven dependency✨
--------------------
- [FAQ](./doc/FAQ.md),There are standard demo display and instructions in the test folder of each project directory,
which can be run directly
- [tank-game-server](https://github.com/zfoo-project/tank-game-server) Online game《The Fight of Tanks》,novice friendly,
difficulty 2 stars
- [godot-bird](https://github.com/zfoo-project/godot-bird) bird and bird,powered by godot
- [cocos-fivechess](https://github.com/zfoo-project/fivechess) five chess,use cocos as client
Ⅳ. Maven dependency✨
------------ ------------
- Environment requirement **JDK 17+**, support **OpenJDK**, **Oracle JDK** and **native GraalVM** - Environment requirement **JDK 17+**, support **OpenJDK**, **Oracle JDK** and **native GraalVM**
@@ -67,6 +54,18 @@ Perfect work development process, complete online solution
</dependency> </dependency>
``` ```
Ⅳ. Tutorials
--------------------
- [FAQ](./doc/FAQ.md),There are standard demo display and instructions in the test folder of each project directory,
which can be run directly
- [tank-game-server](https://github.com/zfoo-project/tank-game-server) Online game《The Fight of Tanks》,novice friendly,
difficulty 2 stars
- [godot-bird](https://github.com/zfoo-project/godot-bird) bird and bird,powered by godot
- [cocos-fivechess](https://github.com/zfoo-project/fivechess) five chess,use cocos as client
Ⅴ. Usage⭐ Ⅴ. Usage⭐
------------ ------------
+19 -19
View File
@@ -5,7 +5,8 @@
----------- -----------
- **极致性能,天生异步,Actor设计思想,无锁化设计,万能RPC框架,GraalVM native编译** - **极致性能,天生异步,Actor设计思想,无锁化设计,万能RPC框架,GraalVM native编译**
- **极致序列化 [zfoo protocol](protocol/README.md)**,协议原生支持 C++ C# Java Go Javascript TypeScript Lua GDScript Python - **极致序列化 [zfoo protocol](protocol/README.md)**,协议原生支持 C++ C# Java Go Javascript TypeScript Lua GDScript
Python
- **高可拓展性**,单台服务器部署,微服务部署,注册中心加集群部署,网关加集群部署,随意搭配 - **高可拓展性**,单台服务器部署,微服务部署,注册中心加集群部署,网关加集群部署,随意搭配
- **上能做游戏服务器框架,下能做应用网站服务器框架** - **上能做游戏服务器框架,下能做应用网站服务器框架**
@@ -29,24 +30,7 @@
- 适合作为 **Godot,Unity,Cocos,Webgl,H5** 的后端基础框架,网络通信协议支持 tcp udp websocket http - 适合作为 **Godot,Unity,Cocos,Webgl,H5** 的后端基础框架,网络通信协议支持 tcp udp websocket http
- 喜欢 [KISS法则](https://baike.baidu.com/item/KISS原则/3242383) 的项目 ,简单的配置,优雅的代码 - 喜欢 [KISS法则](https://baike.baidu.com/item/KISS原则/3242383) 的项目 ,简单的配置,优雅的代码
Ⅲ. 详细的教程和完整的工程案例 Ⅲ. Maven依赖✨
--------------------
- 有问题,先看 [FAQ](./doc/FAQ.md) 能否解决你的问题
- 依然有问题,参考每个工程目录的test文件夹下的标准demo展示和注释说明,可以直接运行
- [问题讨论群QQ: 876280300](https://qm.qq.com/cgi-bin/qm/qr?k=uSo2FnXz50i5UZ1LYZS1sPsVWW9A34v-&jump_from=webapi) <a target="_blank" href="https://qm.qq.com/cgi-bin/qm/qr?k=uSo2FnXz50i5UZ1LYZS1sPsVWW9A34v-&jump_from=webapi"><img src="https://img.shields.io/badge/qq%E8%AE%A8%E8%AE%BA%E7%BE%A4-876280300-green"/></a>
- [tank-game-server](https://github.com/zfoo-project/tank-game-server) 网络游戏《进击的坦克(The Fight of
Tanks)》,新手友好,难度2星
- [godot-bird](https://github.com/zfoo-project/godot-bird) 鸟了个鸟,客户端使用godot开发,服务器依然使用的tank-game-server
- [cocos-fivechess](https://github.com/zfoo-project/fivechess) 五子棋,客户端使用cocos开发
- [zapp](https://github.com/zfoo-project/zapp) 图片分享聊天网站,标准的https企业级网站,难度5星
Ⅳ. Maven依赖✨
------------ ------------
- 环境要求**JDK 17+**,支持**OpenJDK**, **Oracle JDK**, **native GraalVM** - 环境要求**JDK 17+**,支持**OpenJDK**, **Oracle JDK**, **native GraalVM**
@@ -69,6 +53,22 @@
</dependency> </dependency>
``` ```
Ⅳ. 详细的教程和完整的工程案例
--------------------
- 有问题,先看 [FAQ](./doc/FAQ.md) 能否解决你的问题
- 依然有问题,参考每个工程目录的test文件夹下的标准demo展示和注释说明,可以直接运行
- [问题讨论群QQ: 876280300](https://qm.qq.com/cgi-bin/qm/qr?k=uSo2FnXz50i5UZ1LYZS1sPsVWW9A34v-&jump_from=webapi) <a target="_blank" href="https://qm.qq.com/cgi-bin/qm/qr?k=uSo2FnXz50i5UZ1LYZS1sPsVWW9A34v-&jump_from=webapi"><img src="https://img.shields.io/badge/qq%E8%AE%A8%E8%AE%BA%E7%BE%A4-876280300-green"/></a>
- [tank-game-server](https://github.com/zfoo-project/tank-game-server) 网络游戏《进击的坦克(The Fight of
Tanks)》,新手友好,难度2星
- [godot-bird](https://github.com/zfoo-project/godot-bird) 鸟了个鸟,客户端使用godot开发,服务器依然使用的tank-game-server
- [cocos-fivechess](https://github.com/zfoo-project/fivechess) 五子棋,客户端使用cocos开发
- [zapp](https://github.com/zfoo-project/zapp) 图片分享聊天网站,标准的https企业级网站,难度5星
Ⅴ. 使用⭐ Ⅴ. 使用⭐
------------ ------------
+1 -1
View File
@@ -14,7 +14,7 @@ English | [简体中文](./README_CN.md)
### Ⅱ. Quick use ### Ⅱ. Quick use
- Environmental requirements **JDK 11+** - Environment requirement **JDK 17+**, support **OpenJDK**, **Oracle JDK** and **native GraalVM**
- Protocol is an independent project, does not depend on other projects, can be directly opened, locally installed to - Protocol is an independent project, does not depend on other projects, can be directly opened, locally installed to
its own local maven repository, can be used alone its own local maven repository, can be used alone
+1 -1
View File
@@ -11,7 +11,7 @@
### Ⅱ. 快速使用 ### Ⅱ. 快速使用
- 环境要求 **JDK 11+**,可以在 **OpenJDK** 和 **Oracle JDK** 无缝切换 - 环境要求**JDK 17+**,支持**OpenJDK**, **Oracle JDK**, **native GraalVM**
- protocol是独立项目,不依赖其它项目,可以直接打开,本地install到自己的本地maven仓库,即可单独使用 - protocol是独立项目,不依赖其它项目,可以直接打开,本地install到自己的本地maven仓库,即可单独使用