Dorothy SSR

English | 中文

  Dorothy 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.

Android	Linux	Windows	macOS	iOS

Key Features

• 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 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.

• 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".

  

Installation

• Quick start

  • Android

    • 1. Download and install the APK 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.
         • Get software on macOS with Homebrew using

         brew tap ippclub/dorothy-ssr 
         brew install --cask dorothy-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 Dorothy SSR project development, see Official Documents for details.

Quick Start

1. Step 1: 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 2: Write game code

   • Create a new game entry code file of Yuescript under the project folder, named init.

   • Write Hello World code:

_ENV = Dorothy!

with Sprite "Image/logo.png"
   \addTo Director.entry
   \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
     )

3. Step 3: 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 4: 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.

Example Projects

• Sample Project - Loli War

• Sample Project - Zombie Escape

• Example Project - Dismentalism

• Example Project - Luv Sense Digital

Documentation

• API Reference
• Tutorial

Community

• Discord
• QQ Group: 512620381

Contribute

Welcome to participate in the development and maintenance of Dorothy SSR. Please see Contributing Guidelines to learn how to submit Issues and Pull Requests.

License

Dorothy SSR uses the MIT License.