How to Build Dora SSR Engine

1. Get the Source

GitHub

git clone https://github.com/ippclub/Dora-SSR.git

Gitee

git clone https://gitee.com/ippclub/Dora-SSR.git

GitCode

git clone https://gitcode.com/ippclub/Dora-SSR.git

2. Build Game Engine Runtime

Please select the target platform you want to build for.

Windows

1. Install Rust compiler.

2. Run the following script to generate the engine's dependent libraries.

   Tools\build-scripts\build_lib_windows.bat

3. Install Visual Studio Community 2022.

4. Open the project file in the IDE: Projects/Windows/Dora.sln.

5. Compile, debug, and run the project.

macOS

1. Install Rust compiler.

2. Run the following script to generate the engine's dependent libraries.

   Tools/build-scripts/build_lib_macos.sh

3. Install latest Xcode.

4. Open the project file in the IDE: Projects/macOS/Dora.xcodeproj.

5. Compile, debug, and run the project.

iOS

1. Install Rust compiler.

2. Run the following script to generate the engine's dependent libraries.

   Tools/build-scripts/build_lib_ios.sh

3. Install latest Xcode.

4. Open the project file in the IDE: Projects/iOS/Dora.xcodeproj.

5. Compile, debug, and run the project.

Android

1. Install Rust compiler.

2. Run the following script to generate the engine's dependent libraries.

   Tools/build-scripts/build_lib_android.sh

3. Manually generate Lua bindings.

   # Build on Ubuntu
   sudo apt-get install lua5.1
   sudo apt-get install -y luarocks
   sudo luarocks install luafilesystem
   cd Tools/tolua++
   lua tolua++.lua
   
   # Build on macOS
   cd Tools/tolua++
   ./build.sh
   
   # Build on Windows
   cd Tools\tolua++
   build.bat

4. Install latest Android Studio.

5. Open the project directory in the IDE: Projects/Android/Dora.

6. Compile, debug, and run the project.

Linux

1. Install Rust compiler.

2. Run the following script to generate the engine's dependent libraries.

   For x86_64 architecture

   Tools/build-scripts/build_lib_linux_x86_64.sh

   For ARM64 architecture

   Tools/build-scripts/build_lib_linux_aarch64.sh

Ubuntu/Debian

3. Install dependent packages.

   sudo apt-get install -y libsdl2-dev libgl1-mesa-dev libssl-dev

4. Manually generate Lua bindings.

   sudo apt-get install lua5.1
   sudo apt-get install -y luarocks
   sudo luarocks install luafilesystem
   cd Tools/tolua++
   lua tolua++.lua

Arch Linux

3. Install dependent packages.

   sudo pacman -S lua51 luarocks sdl2 openssl gcc make cmake --needed
   # Because the lua version must be 5.1,you need to use lua 5.1 instead of the newest version of lua
   # The easiest way is using 'ln' to create a soft link
   sudo ln -s /usr/bin/lua5.1 /usr/local/bin/lua

4. Manually generate Lua bindings.

   sudo luarocks --lua-version 5.1 install luafilesystem
   cd Tools/tolua++
   lua5.1 tolua++.lua

5. Run the compile scripts.

   • For the first time build

     For ARM architecture

     cd Projects/Linux
     make arm

     For x86_64 architecture

     cd Projects/Linux
     make x86_64

   • For incremental build

     cd Projects/Linux
     make

6. Run the generated software.

   cd Assets
   ../Projects/Linux/build/dora-ssr
   
   # Or specify the resource directory with command line arguments
   ./Projects/Linux/build/dora-ssr --asset Assets

3. Build Web IDE

1. Compile and run the Dora SSR engine.

2. Install the latest version of Node.js.

3. Initialize the project and enter the Dora Dora editor development mode.

   Please select the platform you are building with.

macOS

cd Tools/dora-dora && pnpm install
pnpm build-yarn-editor
pnpm start

Alternatively, you can generate the Web IDE release files for the full Dora SSR project. pnpm build now automatically builds and copies YarnEditor, then syncs the final Web IDE output to Assets/www.

# `pnpm build` also syncs the final output to Assets/www automatically
cd Tools/dora-dora
pnpm build

Linux

cd Tools/dora-dora && pnpm install
pnpm build-yarn-editor
pnpm start

Alternatively, you can generate the Web IDE release files for the full Dora SSR project. pnpm build now automatically builds and copies YarnEditor, then syncs the final Web IDE output to Assets/www.

# `pnpm build` also syncs the final output to Assets/www automatically
cd Tools/dora-dora
pnpm build

Windows

cd Tools\dora-dora && pnpm install
pnpm build-yarn-editor
pnpm start

Alternatively, you can generate the Web IDE release files for the full Dora SSR project. pnpm build now automatically builds and copies YarnEditor, then syncs the final Web IDE output to Assets/www.

# `pnpm build` also syncs the final output to Assets/www automatically
cd Tools\dora-dora
pnpm build