Skip to content

Commit

Permalink
Updated docs. [skip CI]
Browse files Browse the repository at this point in the history
  • Loading branch information
pigpigyyy committed Jan 7, 2025
1 parent 3f5a874 commit 64d7a25
Show file tree
Hide file tree
Showing 13 changed files with 94 additions and 31 deletions.
1 change: 1 addition & 0 deletions Assets/Doc/en/welcome.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
- Supports for the [Teal](https://dora-ssr.net/docs/tutorial/Language%20Tutorial/teal-tutorial) language, a statically typed dialect for Lua.
- Supports [TypeScript](https://dora-ssr.net/docs/tutorial/Language%20Tutorial/Using%20TypeScript%20in%20Dora/try-tstl), a statically typed superset of JavaScript that adds powerful type checking.
- Supports [TSX](https://dora-ssr.net/docs/tutorial/Language%20Tutorial/using-tsx), allows embedding XML/HTML-like text within scripts, used with TypeScript.
- Supports the [Wa](https://wa-lang.org) language, a simple, reliable, and statically typed language running on the built-in WASM runtime with [Wa bindings](https://github.com/IppClub/Dora-SSR/tree/main/Tools/dora-wa).
- Supports the [Rust](https://dora-ssr.net/blog/2024/4/15/rusty-game-dev) language, running on the built-in WASM runtime with Rust bindings.
- 2D [skeletal animation](https://dora-ssr.net/docs/tutorial/Using%20Nodes/using-playable) and [physics engine](https://dora-ssr.net/docs/tutorial/Using%20Nodes/using-physics-1) support.
- Built-in out-of-the-box Web IDE, providing file management, code inspection, completion, highlighting and definition jump.
Expand Down
3 changes: 2 additions & 1 deletion Assets/Doc/zh-Hans/welcome.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,8 @@ Dora SSR 引擎的功能丰富,主要特性包括(可点击链接前往教
- 支持 [Teal](https://ippclub.atomgit.net/Dora-SSR/zh-Hans/docs/tutorial/Language%20Tutorial/teal-tutorial) 语言,编译到 Lua 的静态类型语言。
- 支持 [TypeScript](https://ippclub.atomgit.net/Dora-SSR/zh-Hans/docs/tutorial/Language%20Tutorial/Using%20TypeScript%20in%20Dora/try-tstl) 语言,一门静态类型的 JavaScript 语言的超集,添加了强大的类型检查功能。
- 支持 [TSX](https://ippclub.atomgit.net/Dora-SSR/zh-Hans/docs/tutorial/Language%20Tutorial/using-tsx),允许在脚本中嵌入类似 XML/HTML 的文本,与 TypeScript 一起使用。
- 支持 [Rust](https://ippclub.atomgit.net/Dora-SSR/zh-Hans/blog/2024/4/15/rusty-game-dev) 语言,运行在内置的 WASM 绑定和 VM 上。
- 支持 [Wa](https://wa-lang.org) 语言,一门简单、可靠、静态类型的语言,运行在内置的 [WASM 绑定](https://github.com/IppClub/Dora-SSR/tree/main/Tools/dora-wa) 和运行时上。
- 支持 [Rust](https://ippclub.atomgit.net/Dora-SSR/zh-Hans/blog/2024/4/15/rusty-game-dev) 语言,运行在内置的 WASM 绑定和运行时上。
- 2D [骨骼动画](https://ippclub.atomgit.net/Dora-SSR/zh-Hans/docs/tutorial/Using%20Nodes/using-playable)[物理引擎](https://ippclub.atomgit.net/Dora-SSR/zh-Hans/docs/tutorial/Using%20Nodes/using-physics-1)支持。
- 内置开箱即用的 Web IDE,提供文件管理,代码检查、补全、高亮和定义跳转。
- 支持异步操作 [SQLite](https://ippclub.atomgit.net/Dora-SSR/zh-Hans/docs/tutorial/Managing%20Game%20Data/using-database),进行大量游戏配置数据的实时查询和写入。
Expand Down
14 changes: 11 additions & 3 deletions Docs/docs/tutorial/10.quick-start.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,15 @@ import TabItem from '@theme/TabItem';

# Dora Start!

## 1. Installation
## 1. What is Dora SSR?

<div style={{margin: '30px', width: '200px', height: '200px'}}>
![Dora SSR Logo](@site/static/img/dora.svg)
</div>

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

## 2. Installation

### Android

Expand Down Expand Up @@ -46,7 +54,7 @@ import TabItem from '@theme/TabItem';
- 2. Run the software and access the server address displayed by the software through a browser.
- 3. Start game development.

## 2. Write the Game
## 3. Write the Game

1. Step One: Create a new project
- In the browser, right click on the menu "Assets" of the resource tree on the left side of the Dora Dora editor.
Expand Down Expand Up @@ -220,7 +228,7 @@ with Node!

Click the `🎮` icon in the lower right corner of the editor, then click the `Run` menu item. Alternatively, press the `Ctrl + r` key combination.

## 3. Publish the Game
## 4. Publish the Game

1. Open the right-click menu of the newly created project folder in the game resource tree on the left side of the editor.
2. Click the `Download` option and wait for the browser to prompt for downloading the packaged project file.
8 changes: 8 additions & 0 deletions Docs/i18n/zh-Hans/code.json
Original file line number Diff line number Diff line change
Expand Up @@ -500,5 +500,13 @@
"theme.blog.author.noPosts": {
"message": "This author has not written any posts yet.",
"description": "The text for authors with 0 blog post"
},
"engine_feature_wa_scripting_support": {
"message": "Wa 脚本支持",
"description": "The engine feature title Wa Scripting Support in front page"
},
"engine_feature_description_wa_scripting_support": {
"message": "Dora SSR 支持 Wa 语言,一门简单、可靠且静态类型的语言,运行在内置的 WASM 绑定和 VM 上。适合作为便捷易上手的高性能 WASM 语言开发游戏。",
"description": "The engine feature description Wa Scripting Support in front page"
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,15 @@ import TabItem from '@theme/TabItem';

# Dora 启动!

## 1. 安装
## 1. Dora SSR 是什么?

<div style={{margin: '30px', width: '200px', height: '200px'}}>
![Dora SSR Logo](@site/static/img/dora.svg)
</div>

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

## 2. 安装

### Android

Expand Down
4 changes: 4 additions & 0 deletions Docs/i18n/zh-Hans/docusaurus-theme-classic/footer.json
Original file line number Diff line number Diff line change
Expand Up @@ -38,5 +38,9 @@
"link.item.label.Example": {
"message": "示例",
"description": "The label of footer link with label=Example linking to /docs/example/First%20Game%20Tutorial/start"
},
"logo.alt": {
"message": "Dora SSR Logo",
"description": "The alt text of footer logo"
}
}
20 changes: 0 additions & 20 deletions Docs/i18n/zh-Hans/docusaurus-theme-classic/navbar.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,32 +15,12 @@
"message": "博客",
"description": "Navbar item with label Blog"
},
"item.label.GitHub": {
"message": "GitHub",
"description": "Navbar item with label GitHub"
},
"item.label.Reference": {
"message": "参考手册",
"description": "Navbar item with label Reference"
},
"item.label.Example": {
"message": "示例",
"description": "Navbar item with label Example"
},
"item.label.Git": {
"message": "Git",
"description": "Navbar item with label Git"
},
"item.label.AtomGit": {
"message": "AtomGit",
"description": "Navbar item with label AtomGit"
},
"item.label.Gitee": {
"message": "Gitee",
"description": "Navbar item with label Gitee"
},
"item.label.GitCode": {
"message": "GitCode",
"description": "Navbar item with label GitCode"
}
}
22 changes: 20 additions & 2 deletions Docs/src/components/HomepageFeatures/index.tsx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import React from 'react';
import React, { JSX } from 'react';
import clsx from 'clsx';
import styles from './styles.module.css';
import Translate from '@docusaurus/Translate';
Expand All @@ -9,6 +9,7 @@ const pix_toto = require('@site/static/img/pix-toto.png');
const feature_img_one = require('@site/static/img/1.png');
const feature_img_two = require('@site/static/img/2.png');
const feature_img_three = require('@site/static/img/3.png');
import WaImg from '@site/static/img/wa.svg';

type FeatureItem = {
title: JSX.Element;
Expand Down Expand Up @@ -324,6 +325,23 @@ const EngineFeatureList: FeatureItem[] = [
</Translate>
),
},
{
title: (
<Translate
id='engine_feature_wa_scripting_support'
description='The engine feature title Wa Scripting Support in front page'>
Wa Scripting Support
</Translate>
),
image: <div className={styles.featureImgFixed} style={{padding: 40}}><WaImg style={{width: '100%', height: '100%'}} /></div>,
description: (
<Translate
id='engine_feature_description_wa_scripting_support'
description='The engine feature description Wa Scripting Support in front page'>
Dora SSR supports the Wa language, a simple, reliable, and statically typed language running on the built-in WASM runtime with Wa bindings.
</Translate>
),
},
{
title: (
<Translate
Expand All @@ -337,7 +355,7 @@ const EngineFeatureList: FeatureItem[] = [
<Translate
id='engine_feature_description_rust_scripting_support'
description='The engine feature description Rust Scripting Support in front page'>
Dora SSR supports the Rust language, running on the built-in WASM runtime with Rust bindings.
Dora SSR supports the Rust language, running on the built-in WASM runtime with Rust bindings. Provides a high-performance and secure programming experience.
</Translate>
),
},
Expand Down
Loading

0 comments on commit 64d7a25

Please sign in to comment.