https://github.com/JetBrains/RiderSourceCodeAccess

Plugin for UE4 to user Rider for Unreal Engine as code editor
https://github.com/JetBrains/RiderSourceCodeAccess

Last synced: about 2 months ago
JSON representation

Plugin for UE4 to user Rider for Unreal Engine as code editor

• Host: GitHub
• URL: https://github.com/JetBrains/RiderSourceCodeAccess
• Owner: JetBrains
• License: apache-2.0
• Created: 2019-12-02T08:10:35.000Z (almost 5 years ago)
• Default Branch: main
• Last Pushed: 2023-11-28T20:18:31.000Z (10 months ago)
• Last Synced: 2024-04-13T12:06:57.299Z (5 months ago)
• Language: C++
• Homepage:
• Size: 90.8 KB
• Stars: 107
• Watchers: 9
• Forks: 22
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• awesome-game-security - Plugin for UE4 to user Rider for Unreal Engine as code editor

README

        
[![official JetBrains project](https://jb.gg/badges/official-flat-square.svg)](https://confluence.jetbrains.com/display/ALL/JetBrains+on+GitHub)

# Description

RiderSourceCodeAccess is a plugin for Unreal Engine, available through [Marketplace page](https://www.unrealengine.com/marketplace/en-US/product/rider-source-code-access) that will add an option to select ["Rider for Unreal Engine"](https://www.jetbrains.com/rider/unreal/) as your source code editor in Unreal Editor.

## Functionality

* Adds the option to select "Rider for Unreal Engine" as your IDE of choice in Unreal Editor.

  * You can select a specific version of Rider (e.g. Rider xxx.xx.xx) or,

  * Use the latest version of Rider that’s available on your workstation by selecting `Rider` option or,

  * Use experimental version of .uproject based project model in Rider that is available starting with UE 4.26.1 and Rider for Unreal Engine 2021.1.

* `RiderSourceCodeAccess` looks for `Rider`'s in the next places:

  * Under `JetBrains Toolbox` installation folder;

  * Windows only: `Rider`'s registered in Windows Registry;

  * MacOS and Linux: using `mdfind` utility with `"kMDItemKind == Application"` pattern;

  * Manually installed `Rider`'s. You can specify path to manually installed `Rider` in "RiderSourceCodeAccess\Resources\RiderLocations.txt" file.

![Example of dropdown box with Rider for Unreal Engine](https://user-images.githubusercontent.com/1694911/115036768-76e76c00-9ed6-11eb-8ca5-d457b6051945.png)

# How to add this plugin manually (not recommened)

## How to add to Game project

1. Get the source code of the [main branch](https://github.com/JetBrains/RiderSourceCodeAccess/archive/refs/heads/main.zip); 

2. Unzip `RiderSourceCodeAccess.zip` to `RiderSourceCodeAccess` folder;

3. Copy `RiderSourceCodeAccess` folder to `{GameProjectRoot}/Plugins/Developer`;

  a. If `{GameProjectRoot}/Plugins/Developer` does not exist, create it;

4. (For Windows and .sln project model only) Re-generate solution files - uproject file > context menu > Generate Visual Studio project files;

5. Build UE project using Rider (or any other IDE that you've setup for your OS);

6. Start Unreal Editor;

7. Edit > Editor Preferences ... > General > Source Code > Source Code Editor;

8. Select Rider from drop down list. NB: only Rider with C++ plugins will be available from drop down list.

## How to add to Engine project

### Unreal Engine is built from source code   

1. Get the source code of the [main branch](https://github.com/JetBrains/RiderSourceCodeAccess/archive/refs/heads/main.zip); 

2. Unzip `RiderSourceCodeAccess.zip` to `RiderSourceCodeAccess` folder;

3. Copy `RiderSourceCodeAccess` folder to `{UnrealEngineRoot}/Engine/Plugins/Developer`;

  a. If `{UnrealEngineRoot}/Engine/Plugins/Developer` does not exist, create it;

4. (For Windows and .sln project model only) Re-generate solution files - uproject file > context menu > Generate Visual Studio project files;

5. Build UE project using Rider (or any other IDE that you've setup for your OS);

6. Start Unreal Editor;

7. Edit > Editor Preferences ... > General > Source Code > Source Code Editor;

8. Select Rider from drop down list. NB: only Rider with C++ plugins will be available from drop down list.

### Unreal Engine is downloaded from Epic Games Store

1. Get the source code of the [main branch](https://github.com/JetBrains/RiderSourceCodeAccess/archive/refs/heads/main.zip); 

2. Unzip `RiderSourceCodeAccess.zip` to `RiderSourceCodeAccess` folder;

3. Copy `RiderSourceCodeAccess` folder to `{UnrealProjectRoot}/Plugins/Developer`;

  a. If `{UnrealProjectRoot}/Plugins/Developer` does not exist, create it;

4.(For Windows and .sln project model only) Re-generate solution files - uproject file > context menu > Generate Visual Studio project files;

5. Build UE project using Rider (or any other IDE that you've setup for your OS);

6. Move `RiderSourceCodeAccess` folder from `{UnrealProjectRoot}/Plugins/Developer` to `{UnrealEngineRoot}/Engine/Plugins/Developer`;

7. Start Unreal Editor;

8. Edit > Editor Preferences ... > General > Source Code > Source Code Editor;

9. Select Rider from drop down list. NB: only Rider with C++ plugins will be available from drop down list.