# Dora-SSR
**Repository Path**: examp/Dora-SSR
## Basic Information
- **Project Name**: Dora-SSR
- **Description**: Dora项目，Special Super Rare的新版本。Dora SSR是一个新的2D游戏开发框架，目标是沿用原Dora项目的Lua API和游戏编辑器，使用跨平台的bgfx图形接口和SDL2框架重写底层代码，让Dora游戏框架更具有发展力。
- **Primary Language**: C++
- **License**: MIT
- **Default Branch**: main
- **Homepage**: https://dora-ssr.net/zh-Hans
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 34
- **Created**: 2024-06-29
- **Last Updated**: 2024-06-29
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
# 多萝珍奇引擎（Dora SSR）
#### [English](README.md) | 中文
       
    
----
Dora SSR是一个用于多种设备上快速开发2D游戏的游戏引擎。它内置易用的开发工具链，支持在手机、开源掌机等设备上直接进行游戏开发。
## 示例项目
- [示例项目 - Loli War](Assets/Script/Game/Loli%20War)
- [示例项目 - Zombie Escape](Assets/Script/Game/Zombie%20Escape)
- [示例项目 - Dismentalism](Assets/Script/Game/Dismantlism)
- [示例项目 - Luv Sense Digital](https://github.com/IppClub/LSD)
## 安装配置
- 快速上手
- Android
- 1、在游戏的运行终端下载并安装[APK](https://github.com/ippclub/Dora-SSR/releases/latest)包。
- 2、运行软件，通过局域网内的PC（平板或其他开发设备）的浏览器访问软件显示的服务器地址。
- 3、开始游戏开发。
- Windows、macOS
- 1、下载并运行[软件](https://github.com/ippclub/Dora-SSR/releases/latest)。
- 在macOS上也可以通过 Homebrew 进行软件安装。
```sh
brew tap ippclub/dora-ssr
brew install --cask dora-ssr
```
- 2、运行软件，通过浏览器访问软件显示的服务器地址。
- 3、开始游戏开发。
- Linux
- 1、安装软件：
- Ubuntu Jammy
```sh
sudo add-apt-repository ppa:ippclub/dora-ssr
sudo apt update
sudo apt install dora-ssr
```
- Debian Bookworm
```sh
sudo apt-key adv --keyserver hkp://keyserver.ubuntu.com:80 --recv-keys 9C7705BF
sudo add-apt-repository -S "deb https://ppa.launchpadcontent.net/ippclub/dora-ssr/ubuntu jammy main"
sudo apt update
sudo apt install dora-ssr
```
- 2、运行软件，通过浏览器访问软件显示的服务器地址。
- 3、开始游戏开发。
- 引擎项目开发
进行Dora SSR项目开发的安装配置，详见[官方文档](https://dora-ssr.net/zh-Hans/docs/tutorial/dev-configuration)。
## 快速入门
1. 第一步：创建一个新项目
- 在浏览器中，打开Dora Dora编辑器左侧游戏资源树的右键菜单。
- 点击菜单项`New`，选择新建文件夹。
2. 第二步：编写游戏代码
- 在项目文件夹下新建游戏入口代码文件，选择 Lua (Yuescript, Teal, Typescript 或 TSX) 语言命名为`init`。
- 编写Hello World代码：
- **Lua**
```lua
local _ENV = Dora
local sprite = Sprite("Image/logo.png")
sprite:schedule(once(function()
for i = 3, 1, -1 do
print(i)
sleep(1)
end
print("Hello World")
sprite:perform(Sequence(
Scale(0.1, 1, 0.5),
Scale(0.5, 0.5, 1, Ease.OutBack)
))
end))
```
- **Teal**
```lua
local sleep = require("sleep")
local Ease = require("Ease")
local Scale = require("Scale")
local Sequence = require("Sequence")
local once = require("once")
local Sprite = require("Sprite")
local sprite = Sprite("Image/logo.png")
if not sprite is nil then
sprite:schedule(once(function()
for i = 3, 1, -1 do
print(i)
sleep(1)
end
print("Hello World")
sprite:perform(Sequence(
Scale(0.1, 1, 0.5),
Scale(0.5, 0.5, 1, Ease.OutBack)
))
end))
end
```
- **Yuescript**
有关 Dora SSR 所支持的 Yuescript 这门小众语言的故事在[这里](https://dora-ssr.net/zh-Hans/blog/2024/4/17/a-moon-script-tale)。
```moonscript
_ENV = Dora
with Sprite "Image/logo.png"
\schedule once ->
for i = 3, 1, -1
print i
sleep 1
print "Hello World!"
\perform Sequence(
Scale 0.1, 1, 0.5
Scale 0.5, 0.5, 1, Ease. OutBack
)
```
- **Typescript**
```typescript
import {Sprite, Ease, Scale, Sequence, once, sleep} from 'Dora';
const sprite = Sprite("Image/logo.png");
if (sprite) {
sprite.schedule(once(() => {
for (let i of $range(3, 1, -1)) {
print(i);
sleep(1);
}
print("Hello World");
sprite.perform(Sequence(
Scale(0.1, 1, 0.5),
Scale(0.5, 0.5, 1, Ease.OutBack)
))
}));
}
```
- **TSX**
使用 TSX 语言来创建 Dora SSR 的游戏场景是一个比较容易上手的选择。新手教程可以参见[这里](https://dora-ssr.net/zh-Hans/blog/2024/4/25/tsx-dev-intro)。
```tsx
import {React, toNode, useRef} from 'DoraX';
import {ActionDef, Ease, Sprite, once, sleep} from 'Dora';
const actionRef = useRef();
const spriteRef = useRef();
const onUpdate = once(() => {
for (let i of $range(3, 1, -1)) {
print(i);
sleep(1);
}
print("Hello World");
if (actionRef.current && spriteRef.current) {
spriteRef.current.perform(actionRef.current);
}
});
toNode(
);
```
- **Rust**
也支持使用 Rust 语言来编写游戏代码，编译为 WASM 文件，命名为 `init.wasm` 再上传到引擎中加载运行。详情见[这里](https://dora-ssr.net/zh-Hans/blog/2024/4/15/rusty-game-dev)。
```rust
use dora_ssr::*;
fn main () {
let mut sprite = match Sprite::with_file("Image/logo.png") {
Some(sprite) => sprite,
None => return,
};
let mut sprite_clone = sprite.clone();
sprite.schedule(once(move |mut co| async move {
for i in (1..=3).rev() {
p!("{}", i);
sleep!(co, 1.0);
}
p!("Hello World");
sprite_clone.perform_def(ActionDef::sequence(&vec![
ActionDef::scale(0.1, 1.0, 0.5, EaseType::Linear),
ActionDef::scale(0.5, 0.5, 1.0, EaseType::OutBack),
]));
}));
}
```
3. 第三步：运行游戏
点击编辑器右下角`🎮`图标，然后点击菜单项`Run`。或者按下组合键`Ctrl + r`。
4. 第四步：发布游戏
- 通过编辑器左侧游戏资源树，打开刚才新建的项目文件夹的右键菜单，点击`Download`选项。
- 等待浏览器弹出已打包项目文件的下载提示。
更详细的教程，请查看[官方文档](https://dora-ssr.net/zh-Hans/docs/tutorial/quick-start)。
## 文档
- [API参考](https://dora-ssr.net/zh-Hans/docs/api/intro)
- [教程](https://dora-ssr.net/zh-Hans/docs/tutorial/quick-start)
## 社区
- [Discord](https://discord.gg/ZfNBSKXnf9)
- [QQ群：512620381](https://qm.qq.com/cgi-bin/qm/qr?k=7siAhjlLaSMGLHIbNctO-9AJQ0bn0G7i&jump_from=webapi&authKey=Kb6tXlvcJ2LgyTzHQzKwkMxdsQ7sjERXMJ3g10t6b+716pdKClnXqC9bAfrFUEWa)
## 贡献
欢迎参与Dora SSR的开发和维护。请查看[贡献指南](CONTRIBUTING.zh-CN.md)了解如何提交Issue和Pull Request。
## 许可证
Dora SSR使用[MIT许可证](LICENSE)。原为Dorothy SSR项目，项目名称现处于更名程序中。