Redot Engine Installer (Flatpak & Snap)

This repository provides multiple installation options for Redot Engine, currently supporting both Flatpak and Snap mechanisms.

Installation Options

Flatpak Installation

This version of Redot via Flatpak is not available on Flathub yet, but you can install it manually by downloading the necessary files.

Steps to Install Flatpak Version:

1. Download the Flatpak artifact:

Choose one of the following download methods:

Manual Download:

Visit this release page and download the file named Redot.flatpak.

Download via curl:

curl https://github.com/Redot-Engine/org.redotengine.Redot/releases/download/v4.3-rc.4/Redot.flatpak > Redot.flatpak

2. Install the Flatpak:

Install the downloaded .flatpak file:
```
flatpak install --user Redot.flatpak
```

Updating the Flatpak Version

For now, Flatpak updates aren't automatic. You'll need to manually download and install the latest file each time a new version is released, following the above procedure.

Additional Steps for Using External Tools in Flatpak:

Using Blender: Redot can integrate with Blender installed on your system. Follow the Blender Integration for Flatpak Users.
Using External Script Editor: Learn how to configure external editors like Visual Studio Code to work within the Flatpak version in the External Editor Configuration for Flatpak.

Snap Installation

Redot is now available on the Snap Store. You can install it directly from the Snap Store.

Steps to Install Snap Version:

1. Install the Snap:

Install the Snap file by running:
```
sudo snap install redot
```

Updating the Snap Version

Snap updates are automatic. You will receive the latest updates directly from the Snap Store.

Choosing Between Flatpak and Snap

Both formats offer similar capabilities in terms of functionality. Flatpak provides more flexibility with external editor and tool integration, while Snap users may experience quicker installs. Choose the one based on your system preference or distribution support.

Integration with External Tools

Using Blender with Flatpak

Redot can be integrated with Blender for project asset creation. Users of the Flatpak version need to configure Blender using the following setup.

If Blender is installed from the system (e.g., using distribution packages):

#!/bin/bash
flatpak-spawn --host blender "$@"

If Blender is installed from Flathub:

#!/bin/bash
flatpak-spawn --host flatpak run org.blender.Blender "$@"

After saving this script, ensure it's executable using chmod +x blender. In Redot, navigate to Editor Settings > Filesystem > Import > Blender > Blender 3 Path and set the directory to the location of the blender script.

Using an External Script Editor in Flatpak

Redot can spawn external editors from inside the Flatpak sandbox. You must prefix the command with flatpak-spawn --host.

For instance, if you're using Visual Studio Code, configure it as follows:

Normally:

Exec Path:  code
Exec Flags: --reuse-window {project} --goto {file}:{line}:{col}

With Flatpak:

Exec Path:  flatpak-spawn
Exec Flags: --host code --reuse-window {project} --goto {file}:{line}:{col}

This ensures that the editor is launched outside the sandbox.

Limitations (For Flatpak & Snap)

C#/Mono support via org.redotengine.RedotSharp is not yet supported at this time.

Building from the Source (Flatpak)

git clone --recursive https://github.com/Redot-Engine/org.redotengine.Redot.git
cd org.redotengine.Redot/
git submodule init
git submodule update
flatpak install --user flathub org.freedesktop.Sdk//24.08 -y
flatpak-builder --force-clean --install --user -y builddir org.redotengine.Redot.yaml

Ensure you have Git installed. Follow the Flatpak builder setup guide.

Clone and prepare the repository:

git clone --recursive https://github.com/Redot-Engine/org.redotengine.Redot.git
cd org.redotengine.Redot/
git submodule init
git submodule update
flatpak install --user flathub org.freedesktop.Sdk//24.08 -y

Build and install the Flatpak (using ccache for faster builds):

flatpak-builder --force-clean --install --user --ccache -y builddir org.redotengine.Redot.yaml

Redot-Engine / org.redotengine.Redot

readme