# Dora-SSR
**Repository Path**: odora/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**: 40
- **Created**: 2024-07-13
- **Last Updated**: 2024-07-13
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
# Dora SSR (多萝珍奇引擎)
#### English | [中文](README.zh-CN.md)
       
    
----
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.
## Example Projects
- [Sample Project - Loli War](Assets/Script/Game/Loli%20War)
- [Sample Project - Zombie Escape](Assets/Script/Game/Zombie%20Escape)
- [Example Project - Dismentalism](Assets/Script/Game/Dismantlism)
- [Example Project - Luv Sense Digital](https://github.com/IppClub/LSD)
## Installation
- Quick start
- Android
- 1. Download and install the [APK](https://github.com/ippclub/Dora-SSR/releases/latest) package on the running terminal for games.
- 2. Run the software, and access the server address displayed by the software through the browser of a PC (tablet or other development device) on the LAN.
- 3. Start game development.
- Windows, macOS
- 1. Download and run the [software](https://github.com/ippclub/Dora-SSR/releases/latest).
- For Windows users, ensure that you have the X86 Visual C++ Redistributable for Visual Studio 2022 (the MSVC runtime package vc_redist.x86) installed to run the application. You can download it from the [Microsoft website](https://learn.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist?view=msvc-170).
- Get software on macOS with Homebrew using
```sh
brew tap ippclub/dora-ssr
brew install --cask dora-ssr
```
- 2. Run the software and access the server address displayed by the software through a browser.
- 3. Start game development.
- Linux
- 1. Installation.
- 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. Run the software and access the server address displayed by the software through a browser.
- 3. Start game development.
- Engine project development
For the installation and configuration of Dora SSR project development, see [Official Documents](https://dora-ssr.net/docs/tutorial/dev-configuration) for details.
## Quick Start
1. Step One: Create a new project
- In the browser, open the right-click menu of the game resource tree on the left side of the Dora Dora editor.
- Click on the menu item `New` and choose to create a new folder.
2. Step Two: Write game code
- Create a new game entry code file of Lua (YueScript, Teal, TypeScript or TSX) under the project folder, named `init`.
- Write Hello World code:
- **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**
The story of YueScript, a niche language supported by Dora SSR, can be found [here](https://dora-ssr.net/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**
A much easier approach for building a game scene in Dora SSR. Take the tutorials [here](https://dora-ssr.net/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**
You can write code in Rust, build it into WASM file named `init.wasm`, upload it to engine to run. View details [here](https://dora-ssr.net/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. Step Three: Run the game
Click the `🎮` icon in the lower right corner of the editor, then click the menu item `Run`. Or press the key combination `Ctrl + r`.
4. Step Four: Publish the game
- Open the right-click menu of the project folder just created through the game resource tree on the left side of the editor and click the `Download` option.
- Wait for the browser to pop up a download prompt for the packaged project file.
For more detailed tutorials, please check [official documents](https://Dora-ssr.net/docs/tutorial/quick-start).
## Documentation
- [API Reference](https://Dora-ssr.net/docs/api/intro)
- [Tutorial](https://Dora-ssr.net/docs/tutorial/quick-start)
## Community
- [Discord](https://discord.gg/ZfNBSKXnf9)
- [QQ Group: 512620381](https://qm.qq.com/cgi-bin/qm/qr?k=7siAhjlLaSMGLHIbNctO-9AJQ0bn0G7i&jump_from=webapi&authKey=Kb6tXlvcJ2LgyTzHQzKwkMxdsQ7sjERXMJ3g10t6b+716pdKClnXqC9bAfrFUEWa)
## Contribute
Welcome to participate in the development and maintenance of Dora SSR. Please see [Contributing Guidelines](CONTRIBUTING.md) to learn how to submit Issues and Pull Requests.
## License
Dora SSR uses the [MIT License](LICENSE). The project was originally named Dorothy SSR and is currently undergoing a renaming process.