RiderFlow 2023.1 Help

Getting started

RiderFlow is a plugin for Unity that brings some of JetBrains’ powerful IDE features directly to the Unity Editor. Here they are at a glance:

  • Search Everywhere.

  • Managing the GameObjects Hierarchy view.

  • Finding usages of GameObjects, camera presets, and bookmarks.

  • Refactoring of GameObjects.

  • Smart built-in editor.

RiderFlow is a user plugin, not an SDK, and does not contain a public API for any external usage.

RiderFlow introduction

Requirements

RiderFlow requires Unity 2019.4 LTS or higher.

RiderFlow is tested and officially supported on the following platforms:

  • Windows 10 and Windows 11 (64-bit versions only).

  • macOS 10.14+.

  • Ubuntu 18.04 and Ubuntu 20.04 only for Unity 2021.2+.

Windows

macOS

Linux

2019.4 LTS

Supported

Supported

Not supported

2020.3 LTS

Supported

Supported

Not supported

2021.2+

Supported

Supported

Supported

Install RiderFlow

RiderFlow is a standard Unity extension and should be installed like any other Unity package. You can either download it from the JetBrains website or from UPM (Unity Package Manager).

  1. Visit the RiderFlow page in Unity Asset Store.

    RiderFlow in Unity Asset Store

  2. Click Add to My Assets.

  3. Review and accept the terms of the license agreement.

  4. Click Open in Unity to launch the Unity Hub.

  5. Create a new project or open an existing one.

  6. Once the Package Manager appears, click Download.

  1. In the Unity Editor, select Windows | Package Manager to open Unity Package manager.

  2. Click Advanced to open project settings

    RiderFlow UPM Installation 1

  3. In the Project Settings dialog, fill the new registry fields as follows:

    • Name: JetBrains

    • Url: https://npm.pkg.jetbrains.space/public/p/jetbrains-gamedev/jetbrains-gamedev/

    • Scope(s): com.jetbrains

    RiderFlow UPM Installation 2

  4. Click Save. You might need to wait while Unity refreshes the package manager.

  5. When you are back to the Package Manager, switch to My Registries.

    RiderFlow UPM Installation 3

  6. Click Install to finish the installation.

    RiderFlow UPM Installation 4

  1. Download RiderFlow Unity packages.

  2. Drag the RiderFlow[version].unitypackage into your current project.

  3. Alternatively, go to the Unity Editor and then to the Assets drop-down and select Import Package | Custom Package, and then browse to the RiderFlow.unitypackage file.

  4. Once the Importing dialog appears, click Import.

RiderFlow asset is only 3.5 Mb in size. After you install it, you can immediately use the plugin with bookmarks, notes, sections, toolbars controls, and replace refactoring. Those functions don't require the backend. The only features that are unavailable without the backend are the code editor and global find usages.

Soon after installing or updating of the already existing RiderFlow plugin, the wizard will appear and suggest downloading the backend:

Installation

You can agree and benefit from the full functionality of the plugin, or reject it and keep only the functions that don't require the backend.

If the wizard does not open automatically, you can choose RiderFlow | Show Wizard from the menu.

Just click Download and Install to complete the setup.

After installation, RiderFlow installer archive Backend.zip is left in the Assets directory. This is done on purpose, because the Library directory where RiderFlow binaries reside, can be cleaned up automatically if something goes wrong in Unity Editor. If this happens, the installation wizard will automatically launch on the next Unity Editor start to re-install RiderFlow.

Uninstall RiderFlow

Depending on the way you installed RiderFlow, you can uninstall it as follows:

  • If it was installed from .unitypackage, remove the Assets\Plugins\Editor\JetBrains.RiderFlow folder from your project.

  • If it was installed from UPM, just remove RiderFlow in the Package Manager.

Known Issues

  • Unity 2019.4 LTS: The progress bar is not supported (Debug.Log is used instead).

  • Unity 2019.4 LTS: Recent files are not persisted.

  • Linux: Only 2021.2+ are supported.

  • The 'Show Usages In Scene' effect works only for the classic render (URP/ HDRP is not supported yet, see RF-190).

Feedback

Last modified: 09 October 2023
Search Everywhere