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 5e48210 commit a1b26f7
Show file tree
Hide file tree
Showing 4 changed files with 178 additions and 68 deletions.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ Dora SSR is a game engine for rapid development of games on various devices. It

| Category | Badges |
| - | - |
| Provided Game Dev Tools | ![Static Badge](https://img.shields.io/badge/C%2B%2B20-Game_Engine-d5a64c?logo=c%2B%2B) ![Static Badge](https://img.shields.io/badge/ReactJS-Web_IDE-00d8ff?logo=react&logoColor=white) |
| Supported Languages | ![Static Badge](https://img.shields.io/badge/Rust-Scripting-e36f39?logo=rust) ![Static Badge](https://img.shields.io/badge/Lua-Scripting-blue?logo=lua) ![Static Badge](https://img.shields.io/badge/TypeScript-Scripting-blue?logo=typescript&logoColor=white) ![Static Badge](https://img.shields.io/badge/TSX-Scripting-blue?logo=typescript&logoColor=white) ![Static Badge](https://img.shields.io/badge/Teal-Scripting-blue) ![Static Badge](https://img.shields.io/badge/YueScript-Scripting-blue) |
| Provided Game Dev Tools | ![Static Badge](https://img.shields.io/badge/C%2B%2B20-Game_Engine-d5a64c?logo=c%2B%2B) ![Static Badge](https://img.shields.io/badge/ReactJS-Web_IDE-00d8ff?logo=react) |
| Supported Languages | ![Static Badge](https://img.shields.io/badge/Rust-WASM-e36f39?logo=rust) ![Static Badge](https://img.shields.io/badge/Wa-WASM-e36f39?logo=data%3Aimage%2Fsvg%2Bxml%3Bcharset%3Dutf-8%3Bbase64%2CPHN2ZyB3aWR0aD0iMzAwIiBoZWlnaHQ9IjMwMCIgdmlld0JveD0iMCAwIDMwMCAzMDAiIGZpbGw9Im5vbmUiCiAgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIj4KICA8cGF0aCBmaWxsLXJ1bGU9ImV2ZW5vZGQiIGNsaXAtcnVsZT0iZXZlbm9kZCIgZD0iTTAgMjBDMCA4Ljk1NDMgOC45NTQzIDAgMjAgMEg4MEM5MS4wNDYgMCAxMDAgOC45NTQzIDEwMCAyMFYyNFY4MFYxMDBIMjAwVjgwVjI0VjIwQzIwMCA4Ljk1NDMgMjA4Ljk1NCAwIDIyMCAwSDI4MEMyOTEuMDQ2IDAgMzAwIDguOTU0MyAzMDAgMjBWNDRWODBWMjgwQzMwMCAyOTEuMDQ2IDI5MS4wNDYgMzAwIDI4MCAzMDBIMjBDOC45NTQzIDMwMCAwIDI5MS4wNDYgMCAyODBWODBWNDRWMjBaIiBmaWxsPSIjMDBCNUFCIi8%2BCiAgPHBhdGggZD0iTTUwIDU1QzUyLjc2MTQgNTUgNTUgNTIuNzYxNCA1NSA1MEM1NSA0Ny4yMzg2IDUyLjc2MTQgNDUgNTAgNDVDNDcuMjM4NiA0NSA0NSA0Ny4yMzg2IDQ1IDUwQzQ1IDUyLjc2MTQgNDcuMjM4NiA1NSA1MCA1NVoiIGZpbGw9IndoaXRlIi8%2BCiAgPHBhdGggZD0iTTI1MCA1NUMyNTIuNzYxIDU1IDI1NSA1Mi43NjE0IDI1NSA1MEMyNTUgNDcuMjM4NiAyNTIuNzYxIDQ1IDI1MCA0NUMyNDcuMjM5IDQ1IDI0NSA0Ny4yMzg2IDI0NSA1MEMyNDUgNTIuNzYxNCAyNDcuMjM5IDU1IDI1MCA1NVoiIGZpbGw9IndoaXRlIi8%2BCiAgPHBhdGggZD0iTTE1MCAxODBMMTg0IDIxNEwyMTggMTgwTTE1MCAxODBMMTE2IDIxNEw4MiAxODAiIGZpbGw9Im5vbmUiIHN0cm9rZT0id2hpdGUiIHN0cm9rZS13aWR0aD0iOCIgc3Ryb2tlLWxpbmVjYXA9InJvdW5kIi8%2BCjwvc3ZnPgo%3D) ![Static Badge](https://img.shields.io/badge/Lua-Scripting-blue?logo=lua) ![Static Badge](https://img.shields.io/badge/TypeScript-Script-blue?logo=typescript) ![Static Badge](https://img.shields.io/badge/TSX-Scripting-blue?logo=typescript) ![Static Badge](https://img.shields.io/badge/Teal-Scripting-blue) ![Static Badge](https://img.shields.io/badge/YueScript-Script-blue?logo=data%3Aimage%2Fsvg%2Bxml%3Bcharset%3Dutf-8%3Bbase64%2CPD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiIHN0YW5kYWxvbmU9Im5vIj8%2BCjwhRE9DVFlQRSBzdmcgUFVCTElDICItLy9XM0MvL0RURCBTVkcgMS4xLy9FTiIgImh0dHA6Ly93d3cudzMub3JnL0dyYXBoaWNzL1NWRy8xLjEvRFREL3N2ZzExLmR0ZCI%2BCjxzdmcgd2lkdGg9IjEwMCUiIGhlaWdodD0iMTAwJSIgdmlld0JveD0iMCAwIDM3OCAzMjYiIHZlcnNpb249IjEuMSIgeG1sbnM9Imh0dHA6Ly93d3cudzMub3JnLzIwMDAvc3ZnIiB4bWxuczp4bGluaz0iaHR0cDovL3d3dy53My5vcmcvMTk5OS94bGluayIgeG1sOnNwYWNlPSJwcmVzZXJ2ZSIgeG1sbnM6c2VyaWY9Imh0dHA6Ly93d3cuc2VyaWYuY29tLyIgc3R5bGU9ImZpbGwtcnVsZTpldmVub2RkO2NsaXAtcnVsZTpldmVub2RkO3N0cm9rZS1saW5lam9pbjpyb3VuZDtzdHJva2UtbWl0ZXJsaW1pdDoyOyI%2BCiAgICA8ZyB0cmFuc2Zvcm09Im1hdHJpeCgxLDAsMCwxLC0yOTguNCwtNTguMykiPgogICAgICAgIDxnPgogICAgICAgICAgICA8cGF0aCBkPSJNNDE2LjgsMzIyLjVDNDEzLjEsMzIzLjMgNDA4LjcsMzI0LjEgNDA1LjEsMzI0LjhDNDA1LjYsMzIyLjggNDA3LDMxNyA0MDgsMzEzLjNMNDA1LjIsMzEwLjRMNDAxLjksMzI0LjlDNDAxLjksMzI1LjEgNDAxLjgsMzI1LjMgNDAxLjYsMzI1LjVMMzk1LjYsMzMxLjJMMzk4LDMzMy44TDQwNC4xLDMyOEM0MDQuMywzMjcuOCA0MDQuNCwzMjcuNyA0MDQuNiwzMjcuN0w0MTkuMywzMjUuMkw0MTYuOCwzMjIuNVoiIHN0eWxlPSJmaWxsOnJnYigxODAsMTcyLDE0Myk7ZmlsbC1ydWxlOm5vbnplcm87Ii8%2BCiAgICAgICAgICAgIDxwYXRoIGQ9Ik00MzIuNCwzNTEuN0M0MzAuNSwzNTQuNCA0MjguMiwzNTUuNiA0MjQuNiwzNTMuMkM0MjEsMzUwLjcgNDIxLjIsMzQ4IDQyMywzNDUuNEw0MzAuNywzMzQuMkw0MjcuOCwzMzIuMkw0MjAsMzQzLjZDNDE3LjIsMzQ3LjYgNDE3LjcsMzUxLjUgNDIzLjIsMzU1LjNDNDI5LjEsMzU5LjMgNDMyLjksMzU3LjcgNDM1LjQsMzU0TDQ0My4xLDM0Mi43TDQ0MC4xLDM0MC43TDQzMi40LDM1MS43WiIgc3R5bGU9ImZpbGw6cmdiKDE4MCwxNzIsMTQzKTtmaWxsLXJ1bGU6bm9uemVybzsiLz4KICAgICAgICAgICAgPHBhdGggZD0iTTQ0OC4xLDM2OS4xTDQ2Mi41LDM3NC44TDQ2My45LDM3Mi43TDQ1Mi4zLDM2OEw0NTUsMzYxLjJMNDY1LjYsMzY1LjRMNDY2LjUsMzYzTDQ1NiwzNTguOEw0NTguNCwzNTIuOUw0NjkuNCwzNTcuM0w0NzAuMywzNTVMNDU2LjEsMzQ5LjNMNDQ4LjEsMzY5LjFaIiBzdHlsZT0iZmlsbDpyZ2IoMTgwLDE3MiwxNDMpO2ZpbGwtcnVsZTpub256ZXJvOyIvPgogICAgICAgICAgICA8cGF0aCBkPSJNNDkwLjYsMzU5LjZDNDg1LjksMzU4LjggNDgyLjQsMzYwLjQgNDgxLjgsMzYzLjhDNDgxLjMsMzY2LjggNDgzLDM2OC43IDQ4OC4xLDM3MUM0OTIuMSwzNzIuOCA0OTMuMywzNzQgNDkyLjksMzc2LjNDNDkyLjUsMzc4LjUgNDkwLjUsMzc5LjQgNDg3LjUsMzc4LjlDNDg0LjYsMzc4LjQgNDgyLjgsMzc2LjcgNDgyLjcsMzc0LjFMNDc5LjIsMzczLjVDNDc4LjksMzc3LjQgNDgxLjYsMzgwLjMgNDg2LjgsMzgxLjNDNDkyLjUsMzgyLjMgNDk1LjgsMzgwLjIgNDk2LjQsMzc2LjdDNDk2LjksMzczLjggNDk1LjcsMzcxLjUgNDg5LjgsMzY4LjhDNDg2LjEsMzY3LjEgNDg0LjksMzY2LjIgNDg1LjIsMzY0LjNDNDg1LjUsMzYyLjUgNDg3LjEsMzYxLjYgNDg5LjksMzYyLjFDNDkyLjksMzYyLjYgNDk0LDM2NC4yIDQ5NCwzNjYuM0w0OTcuNCwzNjYuOUM0OTgsMzYzLjYgNDk2LjEsMzYwLjYgNDkwLjYsMzU5LjZaIiBzdHlsZT0iZmlsbDpyZ2IoMTgwLDE3MiwxNDMpO2ZpbGwtcnVsZTpub256ZXJvOyIvPgogICAgICAgICAgICA8cGF0aCBkPSJNNTIyLjMsMzgxLjFDNTE3LjEsMzgxLjMgNTE1LjMsMzc3LjEgNTE1LjIsMzcyLjdDNTE1LDM2OC4zIDUxNi44LDM2NC4zIDUyMS42LDM2NC4xQzUyNS4zLDM2NCA1MjYuOCwzNjUuNyA1MjcuNSwzNjhMNTMxLDM2Ny45QzUzMC40LDM2NC40IDUyNy42LDM2MS40IDUyMS42LDM2MS42QzUxNC40LDM2MS45IDUxMS4zLDM2Ny4xIDUxMS41LDM3Mi44QzUxMS43LDM3OS4xIDUxNC43LDM4My44IDUyMi4zLDM4My41QzUyOC40LDM4My4zIDUzMC45LDM4MCA1MzEuNSwzNzYuNUw1MjgsMzc2LjZDNTI3LjQsMzc5IDUyNiwzODEgNTIyLjMsMzgxLjFaIiBzdHlsZT0iZmlsbDpyZ2IoMTgwLDE3MiwxNDMpO2ZpbGwtcnVsZTpub256ZXJvOyIvPgogICAgICAgICAgICA8cGF0aCBkPSJNNTYzLjcsMzcwLjdDNTYzLDM2Ny45IDU2MS41LDM2Ni41IDU1OC44LDM2Ni41QzU2MC42LDM2NS40IDU2Mi4zLDM2My42IDU2MS41LDM2MC42QzU2MC42LDM1Ny4xIDU1NywzNTYgNTUyLjYsMzU3LjJMNTQzLjcsMzU5LjVMNTQ5LDM4MC4xTDU1Mi40LDM3OS4yTDU1MCwzNzBMNTU0LjEsMzY4LjlDNTU4LDM2Ny45IDU1OS41LDM2OC43IDU2MC4yLDM3MS41TDU2MC4zLDM3MS45QzU2MC45LDM3NC4xIDU2MS40LDM3NS45IDU2MiwzNzYuN0w1NjUuNCwzNzUuOEM1NjQuOCwzNzQuNyA1NjQuMywzNzIuOSA1NjMuOCwzNzFMNTYzLjcsMzcwLjdaTTU1My44LDM2Ni41TDU0OS40LDM2Ny42TDU0Ny43LDM2MC45TDU1Mi44LDM1OS42QzU1NS42LDM1OC45IDU1Ny42LDM1OS41IDU1OC4xLDM2MS42QzU1OC44LDM2NC41IDU1Ni44LDM2NS44IDU1My44LDM2Ni41WiIgc3R5bGU9ImZpbGw6cmdiKDE4MCwxNzIsMTQzKTtmaWxsLXJ1bGU6bm9uemVybzsiLz4KICAgICAgICAgICAgPGcgdHJhbnNmb3JtPSJtYXRyaXgoMC45MTA1LC0wLjQxMzYsMC40MTM2LDAuOTEwNSwtOTYuMTEyNSwyNzIuNzE3KSI%2BCiAgICAgICAgICAgICAgICA8cmVjdCB4PSI1NzcuNCIgeT0iMzQ4LjMiIHdpZHRoPSIzLjUiIGhlaWdodD0iMjEuMyIgc3R5bGU9ImZpbGw6cmdiKDE4MCwxNzIsMTQzKTsiLz4KICAgICAgICAgICAgPC9nPgogICAgICAgICAgICA8cGF0aCBkPSJNNTk3LDMzNi42TDU4OS44LDM0MS41TDYwMS44LDM1OS4xTDYwNC43LDM1Ny4xTDU5OS42LDM0OS43TDYwMy41LDM0N0M2MDcuOCwzNDQuMSA2MDkuNiwzNDAuMyA2MDcuMiwzMzYuOEM2MDUuMSwzMzMuNiA2MDAuOSwzMzMuOSA1OTcsMzM2LjZaTTYwMi4xLDM0NS4xTDU5OC40LDM0Ny43TDU5NC4yLDM0MS41TDU5OCwzMzguOUM2MDAuNiwzMzcuMSA2MDMsMzM2LjkgNjA0LjQsMzM4LjlDNjA2LDM0MS4zIDYwNC43LDM0My4zIDYwMi4xLDM0NS4xWiIgc3R5bGU9ImZpbGw6cmdiKDE4MCwxNzIsMTQzKTtmaWxsLXJ1bGU6bm9uemVybzsiLz4KICAgICAgICAgICAgPHBhdGggZD0iTTYyNi42LDMxMy40TDYyNC43LDMxMS42TDYxMi4xLDMyNC44TDYxNCwzMjYuNUw2MTksMzIxLjJMNjMyLjYsMzM0LjJMNjM1LjEsMzMxLjZMNjIxLjUsMzE4LjdMNjI2LjYsMzEzLjRaIiBzdHlsZT0iZmlsbDpyZ2IoMTgwLDE3MiwxNDMpO2ZpbGwtcnVsZTpub256ZXJvOyIvPgogICAgICAgICAgICA8cGF0aCBkPSJNNTQxLjIsNjAuMkM1MzkuMSw1OS45IDUzNyw1OS42IDUzNC45LDU5LjNMNTM0LjksNzQuMkM1NTcuMyw5OC40IDU3MS44LDEzMC4xIDU3My45LDE2NS4xTDQzNS43LDE2NS4xQzQzNS43LDE2NS4xIDQyMS43LDE2NS44IDQyMS43LDE3Ny40QzQyMS43LDE4OS41IDQzMi44LDE5MS41IDQzNS42LDE5MS41TDUwNSwxOTEuNUM1MDUsMTkxLjUgNTEzLjcsMTkxIDUxMy43LDE5Ny42QzUxMy43LDIwMy45IDUwNy4zLDIwMy42IDUwNS4xLDIwMy42TDM2My42LDIwMy42QzM3NC42LDEyOS4zIDQzMi44LDcwLjQgNTA2LjcsNTguM0M0MjcsNjIuNSAzNjIuNSwxMjQuOCAzNTQuOCwyMDMuNkwzMTMuNywyMDMuNkMzMTMuNywyMDMuNiAyOTguNCwyMDEuOCAyOTguNCwyMTUuMUMyOTguNCwyMjguNCAzMDkuOSwyMjcuOSAzMTMuMSwyMjcuOUwzNTQuMiwyMjcuOUMzNTUuNywyNTYuMiAzNjQuNiwyODIuNyAzNzguOSwzMDUuM0wzNzksMzA1LjJDMzcwLjIsMjg3LjMgMzY0LjUsMjY3LjYgMzYyLjQsMjQ2LjhMNDM3LjcsMjQ2LjhDNDQxLjMsMjQ2LjggNDUxLjQsMjQ2LjMgNDUxLjQsMjM0LjZDNDUxLjQsMjIzIDQzOSwyMjIuNyA0MzksMjIyLjdMMzM3LjIsMjIyLjdDMzM3LjIsMjIyLjcgMzI4LjMsMjIzLjQgMzI4LjMsMjE2LjNDMzI4LjMsMjA5LjIgMzM0LjEsMjA4LjkgMzM2LjcsMjA4LjlMNTI3LjIsMjA4LjlDNTI3LjIsMjA4LjkgNTQxLjgsMjEwLjUgNTQxLjgsMTk3QzU0MS44LDE4NSA1MjksMTg1LjUgNTI0LjMsMTg1LjVMNDU5LjIsMTg1LjVDNDU5LjIsMTg1LjUgNDQ5LjUsMTg1LjkgNDQ5LjUsMTc4LjZDNDQ5LjUsMTcxLjMgNDU3LjcsMTcxLjcgNDU5LjEsMTcxLjdMNTczLjgsMTcxLjdMNTczLjgsMTczLjlDNTczLjgsMjEyLjQgNTU4LjksMjQ3LjUgNTM0LjUsMjczLjdDNTEyLjksMjk3IDQ4My44LDMxMy4zIDQ1MSwzMTguOEM0NTcuMywzMjIuNyA0NjMuOSwzMjYuMSA0NzAuOCwzMjlDNDk0LjcsMzIyLjIgNTE2LjQsMzEwIDUzNC40LDI5My44QzU0OS4xLDI4MC42IDU2MS40LDI2NC42IDU3MC41LDI0Ni44TDY0MS42LDI0Ni44TDY0MS42LDI0MC4xTDU3My43LDI0MC4xQzU4Mi44LDIxOS45IDU4Ny45LDE5Ny41IDU4Ny45LDE3My45TDU4Ny45LDE3MS43TDY1My44LDE3MS43QzY1OC45LDE4Ni42IDY2MS43LDIwMi41IDY2MS43LDIxOS4xQzY2MS43LDI0Ni42IDY1NC4xLDI3Mi40IDY0MC44LDI5NC41TDY1MiwzMDMuNkM2NjcuMiwyNzkgNjc2LDI1MC4xIDY3NiwyMTkuMUM2NzYuNCwxMzkuMiA2MTcuOCw3Mi42IDU0MS4yLDYwLjJaTTQyMy45LDIzNS4zQzQyMy45LDI0MS44IDQxNy42LDI0Mi4yIDQxNy42LDI0Mi4yTDM2Mi4yLDI0Mi4yQzM2MS45LDIzNy45IDM2MS43LDIzMy42IDM2MS43LDIyOS4zTDM2MS43LDIyNy45TDQxOC4yLDIyNy45QzQxOS4yLDIyOCA0MjMuOSwyMjguOCA0MjMuOSwyMzUuM1pNNTg4LjIsMTY1LjFDNTg2LjQsMTMyLjcgNTc1LjEsMTAyLjkgNTU2LjksNzguNEM2MDAuMiw5MS4yIDYzNS4zLDEyMy41IDY1MS45LDE2NS4xTDU4OC4yLDE2NS4xWiIgc3R5bGU9ImZpbGw6cmdiKDE4MCwxNzIsMTQzKTtmaWxsLXJ1bGU6bm9uemVybzsiLz4KICAgICAgICA8L2c%2BCiAgICA8L2c%2BCjwvc3ZnPgo%3D) |
| Supported Platforms | ![Android](https://github.com/ippclub/Dora-SSR/actions/workflows/android.yml/badge.svg) ![Linux](https://github.com/ippclub/Dora-SSR/actions/workflows/linux.yml/badge.svg) ![Windows](https://github.com/ippclub/Dora-SSR/actions/workflows/windows.yml/badge.svg) ![macOS](https://github.com/ippclub/Dora-SSR/actions/workflows/macos.yml/badge.svg) ![iOS](https://github.com/ippclub/Dora-SSR/actions/workflows/ios.yml/badge.svg) |

<div align='center'><img src='Docs/static/img/3.png' alt='Playground' width='500px'/></div>
Expand Down Expand Up @@ -45,6 +45,7 @@ Dora SSR is a game engine for rapid development of games on various devices. It
|TypeScript|Supports [TypeScript](https://www.typescriptlang.org), a statically typed superset of JavaScript that adds powerful type checking (with [TSTL](https://typescripttolua.github.io)).|
|TSX|Supports [TSX](https://dora-ssr.net/docs/tutorial/Language%20Tutorial/using-tsx), allows embedding XML/HTML-like text within scripts, used with TypeScript.|
|Rust|Supports the [Rust](https://www.rust-lang.org) language, running on the built-in WASM runtime with [Rust bindings](https://lib.rs/crates/dora-ssr).|
|Wa|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).|
|2D Animation|2D skeletal animations support with [Spine2D](https://github.com/EsotericSoftware/spine-runtimes), [DragonBones](https://github.com/DragonBones/DragonBonesCPP) and a builtin system.|
|2D Physics|2D physics engine support with [PlayRho](https://github.com/louis-langholtz/PlayRho).|
|Web IDE|Built-in out-of-the-box Web IDE, providing file management, code inspection, completion, highlighting and definition jump. <br><br><div align='center'><img src='Docs/static/img/dora-on-android.jpg' alt='LSD' width='500px'/></div>|
Expand Down Expand Up @@ -133,9 +134,9 @@ Dora SSR is a game engine for rapid development of games on various devices. It
- 2\. Run the software and access the server address displayed by the software through a browser.
- 3\. Start game development.

### Game engine development
### Build Game Engine

For the installation and configuration of Dora SSR project development, see [Official Documents](https://dora-ssr.net/docs/tutorial/dev-configuration) for details.
- For the building instructions of Dora SSR project, see [Official Documents](https://dora-ssr.net/docs/tutorial/dev-configuration) for details.

<br>

Expand Down
Loading

0 comments on commit a1b26f7

Please sign in to comment.