Skip to content

Commit

Permalink
update docs. [skip CI]
Browse files Browse the repository at this point in the history
  • Loading branch information
pigpigyyy committed May 14, 2024
1 parent b1da621 commit 5f3e11e
Show file tree
Hide file tree
Showing 4 changed files with 79 additions and 55 deletions.
40 changes: 24 additions & 16 deletions Assets/Doc/en/welcome.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,26 +8,34 @@

  The Dora SSR engine offers a rich set of features, including:

* Game scene management based on a tree-like node structure
* ECS module for simplified game entity management
* Asynchronous file I/O, resource loading, and other operations
* Upgraded Lua bindings with support for TSX, Yuescript, Teal and Typescript
* Built-in WASM bindings and VM for running Rust language
* 2D skeletal animation and physics engine
* Built-in Web IDE with file management, code checking, autocompletion, highlighting, and definition jumping
* Support for asynchronous SQLite operations for real-time querying and writing of large amounts of game configuration data
* Reading Excel spreadsheet data with support for synchronization to SQLite tables
* Machine learning algorithm framework for innovative gameplay
* Supports the Yarn Spinner language, making it easy to write complex game story systems
* Vector graphics rendering API for directly rendering CSS-less SVG format files
* Built-in ImGui for creating debugging tools and UI interfaces
* Playback of audio in multiple formats and rendering of TrueType fonts
* Open art assets and game IPs available for creating your own games — [Luv Sense Digital](http://luvsensedigital.org)
- Manages game scenes based on tree node structure.
- Basic 2D platform game functions, including game logic and AI development framework.
- Easy-to-use ECS module for game entity management.
- Asynchronous processing of file read and write, resource loading and other operations.
- Upgraded Lua binding with support for inheriting and extending low-level C++ objects.
- Supports Yuescript language, strong expressive and concise Lua dialect.
- Supports for the Teal language, a statically typed dialect for Lua.
- Supports TypeScript, a statically typed superset of JavaScript that adds powerful type checking.
- Supports TSX, allows embedding XML/HTML-like text within scripts, used with TypeScript.
- Supports the Rust language, running on the built-in WASM runtime with Rust bindings.
- 2D skeletal animation and physics engine support.
- Built-in out-of-the-box Web IDE, providing file management, code inspection, completion, highlighting and definition jump.
- Supports asynchronous operation of SQLite for real-time query and managing large game configuration data.
- Supports reading Excel spreadsheet data and synchronizing it to SQLite tables.
- Provides the function of adaptive Flex layout for game scenes through CSS.
- Support the functions of Effekseer game effects system.
- Supports the Yarn Spinner language, making it easy to write complex game story systems.
- Built-in machine learning algorithm framework for innovative gameplay.
- Provides vector graphics rendering API, which can directly render SVG format files without CSS.
- Built-in ImGui, easy to create debugging tools and UI interface.
- Supports FLAC, OGG, MP3 and WAV multi-format audio playback.
- Supports True Type font rendering and basic typesetting.
- Provides open art resources and game IPs that can be used to create your own games - ["Luv Sense Digital"](https://luv-sense-digital.readthedocs.io).

## Community Participation

  We hope you can utilize the Dora SSR game engine to unleash your creativity and create amazing games. During this process, if you encounter any problems or have any suggestions, please feel free to contact us. We will do our best to provide support.

  Thank you for choosing the Dora SSR game engine. Let's create infinite possibilities together!

* [Discord](https://discord.gg/ydJVuZhh)
* [Discord](https://discord.gg/ZfNBSKXnf9)
48 changes: 28 additions & 20 deletions Assets/Doc/zh-Hans/welcome.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,32 +2,40 @@

![logo:250](../image/dora-toto.png)

  祝贺您发现了这个宝藏!Dora SSR是一个专注在多种移动设备上快速开发游戏的软件。游戏的开发工具链也包含其中,只需要一个运行设备(如:手机,开源游戏掌机),以及一台任意的编码工具(如:PC、平板),打开软件和浏览器就能立即开始制作游戏。
  祝贺您发现了这个宝藏!Dora SSR 是一个专注在多种移动设备上快速开发游戏的软件。游戏的开发工具链也包含其中,只需要一个运行设备(如:手机,开源游戏掌机),以及一台任意的编码工具(如:PC、平板),打开软件和浏览器就能立即开始制作游戏。

## 主要特性

Dora SSR引擎的功能丰富,主要特性包括:

* 基于树形节点的游戏场景管理
* ECS模块,简化游戏实体管理
* 异步处理的文件读写、资源加载等操作
* 升级的Lua绑定,支持TSX,Yuescript,Teal和Typescript等多种语言
* 内置WASM绑定和VM,运行Rust语言
* 2D骨骼动画和物理引擎
* 内置Web IDE,包括文件管理,代码检查、补全、高亮和定义跳转
* 支持异步操作SQLite,进行大量游戏配置数据的实时查询和写入
* Excel表格数据读取,支持同步到SQLite库表
* 机器学习算法框架,用于创新游戏玩法
* 支持Yarn Spinner语言,便于编写复杂的游戏故事系统
* 提供矢量图形渲染API,可直接渲染无CSS的SVG格式文件
* 内置ImGui,便于创建调试工具和UI界面
* 多格式音频播放和True Type字体的渲染
* 提供可用于制作自己游戏的开放美术素材和游戏IP —— [《灵数奇缘》](http://luvsensedigital.org)
Dora SSR 引擎的功能丰富,主要特性包括:

- 基于树形结点结构管理游戏场景。
- 基础的 2D 平台游戏功能,包括游戏逻辑和 AI 开发框架。
- 易用的 ECS 模块,便于游戏实体管理。
- 异步处理的文件读写、资源加载等操作。
- 升级的 Lua 绑定,支持继承和扩展底层 C++ 对象。
- 支持 Yuescript 语言,强表达力且简洁的 Lua 方言。
- 支持 Teal 语言,编译到 Lua 的静态类型语言。
- 支持 TypeScript 语言,一门静态类型的 JavaScript 语言的超集,添加了强大的类型检查功能。
- 支持 TSX,允许在脚本中嵌入类似 XML/HTML 的文本,与 TypeScript 一起使用。
- 支持 Rust 语言,运行在内置的 WASM 绑定和 VM 上。
- 2D 骨骼动画和物理引擎支持。
- 内置开箱即用的 Web IDE,提供文件管理,代码检查、补全、高亮和定义跳转。
- 支持异步操作 SQLite,进行大量游戏配置数据的实时查询和写入。
- 支持 Excel 表格数据读取,支持同步到SQLite库表。
- 提供游戏场景通过 CSS 进行自适应的 Flex 布局的功能。
- 支持 Effekseer 特效系统的功能。
- 内置用于创新游戏玩法的机器学习算法框架。
- 支持 Yarn Spinner 语言,便于编写复杂的游戏故事系统。
- 提供矢量图形渲染 API,可直接渲染无 CSS 的 SVG 格式文件。
- 内置 ImGui,便于创建调试工具和UI界面。
- 支持 FLAC、OGG、MP3 和 WAV 多格式音频播放。
- 支持 True Type 字体的渲染和基础排版。
- 提供可用于制作自己游戏的开放美术素材和游戏 IP —— [《灵数奇缘》](https://luv-sense-digital.readthedocs.io)

## 参与社区

  我们希望您能够利用Dora SSR游戏引擎,释放您的创造力,制作出令人惊叹的游戏。在这个过程中,如果您遇到任何问题或者有任何建议,都欢迎您与我们联系,我们将全力为您提供支持。
  我们希望您能够利用 Dora SSR 游戏引擎,释放您的创造力,制作出令人惊叹的游戏。在这个过程中,如果您遇到任何问题或者有任何建议,都欢迎您与我们联系,我们将全力为您提供支持。

  感谢您选择Dora SSR游戏引擎,让我们一起创造无限可能吧!
  感谢您选择 Dora SSR 游戏引擎,让我们一起创造无限可能吧!

* [QQ群:512620381](https://qm.qq.com/cgi-bin/qm/qr?k=7siAhjlLaSMGLHIbNctO-9AJQ0bn0G7i&jump_from=webapi&authKey=Kb6tXlvcJ2LgyTzHQzKwkMxdsQ7sjERXMJ3g10t6b+716pdKClnXqC9bAfrFUEWa)
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@

Dora SSR is a game engine for rapid development of 2D games on various devices. It has a built-in easy-to-use development tool chain that supports direct game development on mobile phones, open source handhelds and other devices.

<img src='Site/static/img/3.png' alt='Playground' width='600px'/>
<img src='Doc/static/img/3.png' alt='Playground' width='600px'/>

## Dora SSR Joins the Open Atom Foundation

Expand Down Expand Up @@ -51,6 +51,10 @@ The Open Atom Foundation is a non-profit organization dedicated to supporting an

- Supports reading Excel spreadsheet data and synchronizing it to SQLite tables.

- Provides the function of adaptive Flex layout for game scenes through CSS.

- Support the functions of Effekseer game effects system.

- Supports the Yarn Spinner language, making it easy to write complex game story systems.

- Built-in machine learning algorithm framework for innovative gameplay.
Expand Down
40 changes: 22 additions & 18 deletions README.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@

&emsp;&emsp;Dora SSR是一个用于多种设备上快速开发2D游戏的游戏引擎。它内置易用的开发工具链,支持在手机、开源掌机等设备上直接进行游戏开发。

<img src='Site/static/img/3.png' alt='Playground' width='600px'/>
<img src='Doc/static/img/3.png' alt='Playground' width='600px'/>

## Dora SSR 项目现已加入开放原子开源基金会

Expand All @@ -25,45 +25,49 @@

- 基于树形结点结构管理游戏场景。

- 基础的2D平台游戏功能,包括游戏逻辑和AI开发框架
- 基础的 2D 平台游戏功能,包括游戏逻辑和 AI 开发框架

- 易用的ECS模块,便于游戏实体管理。
- 易用的 ECS 模块,便于游戏实体管理。

- 异步处理的文件读写、资源加载等操作。

- 升级的Lua绑定,支持继承和扩展底层C++对象。
- 升级的 Lua 绑定,支持继承和扩展底层 C++ 对象。

- 支持Yuescript语言,强表达力且简洁的Lua方言
- 支持 Yuescript 语言,强表达力且简洁的 Lua 方言

- 支持Teal语言,编译到Lua的静态类型语言
- 支持 Teal 语言,编译到 Lua 的静态类型语言

- 支持 TypeScript,一门静态类型的 JavaScript 语言的超集,添加了强大的类型检查功能。
- 支持 TypeScript 语言,一门静态类型的 JavaScript 语言的超集,添加了强大的类型检查功能。

- 支持 TSX,允许在脚本中嵌入类似 XML/HTML 的文本,与 TypeScript 一起使用。

- 支持Rust语言,运行在内置的WASM绑定和VM上
- 支持 Rust 语言,运行在内置的 WASM 绑定和 VM 上

- 2D骨骼动画和物理引擎支持
- 2D 骨骼动画和物理引擎支持

- 内置开箱即用的Web IDE,提供文件管理,代码检查、补全、高亮和定义跳转。
- 内置开箱即用的 Web IDE,提供文件管理,代码检查、补全、高亮和定义跳转。

- 支持异步操作SQLite,进行大量游戏配置数据的实时查询和写入。
- 支持异步操作 SQLite,进行大量游戏配置数据的实时查询和写入。

- 支持Excel表格数据读取,支持同步到SQLite库表。
- 支持 Excel 表格数据读取,支持同步到SQLite库表。

- 提供游戏场景通过 CSS 进行自适应的 Flex 布局的功能。

- 支持 Effekseer 特效系统的功能。

- 内置用于创新游戏玩法的机器学习算法框架。

- 支持Yarn Spinner语言,便于编写复杂的游戏故事系统。
- 支持 Yarn Spinner 语言,便于编写复杂的游戏故事系统。

- 提供矢量图形渲染API,可直接渲染无CSS的SVG格式文件
- 提供矢量图形渲染 API,可直接渲染无 CSS 的 SVG 格式文件

- 内置ImGui,便于创建调试工具和UI界面。
- 内置 ImGui,便于创建调试工具和UI界面。

- 支持FLAC、OGG、MP3和WAV多格式音频播放
- 支持 FLAC、OGG、MP3 和 WAV 多格式音频播放

- 支持True Type字体的渲染和基础排版
- 支持 True Type 字体的渲染和基础排版

- 提供可用于制作自己游戏的开放美术素材和游戏IP —— [《灵数奇缘》](https://luv-sense-digital.readthedocs.io)
- 提供可用于制作自己游戏的开放美术素材和游戏 IP —— [《灵数奇缘》](https://luv-sense-digital.readthedocs.io)

&emsp;&emsp;<img src='Assets/Image/LSD.jpg' alt='LSD' width='300px'/>

Expand Down

0 comments on commit 5f3e11e

Please sign in to comment.