Skip to content

Commit

Permalink
Merging changes to README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
DecoyRS committed Apr 29, 2020
2 parents 0f41889 + 283d624 commit d5469e2
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 10 deletions.
44 changes: 35 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,36 @@
How to add RiderSourceCodeAccess to your project
###
1. Copy `RiderSourceCodeAccess` folder:
1. Engine from sources: to `{UnrealEngineRoot}/Engine/Plugins/Developer` or to `{UnrealProjectRoot}/Plugins/Developer`;
2. Engine from Epic store: to `{UnrealProjectRoot}/Plugins/Developer`;
2. Re-generate solution files - uproject file > context menu > Generate Visual Studio project files;
3. Build UE project using Rider or Visual Studio;
4. Start Unreal Editor;
5. Edit > Editor Preferences ... > General > Source Code > Source Code Editor;
6. Select Rider from drop down list. NB: only Rider with C++ plugins will be available from drop down list.

## How to add to Game project
1. Go to ["Releases" page](https://github.com/JetBrains/RiderSourceCodeAccess/releases) and download version of plugin for your version of Unreal Engine;
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. Re-generate solution files - uproject file > context menu > Generate Visual Studio project files;
5. Build UE project using Rider or Visual Studio;
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
### Project is built from source code
1. Go to ["Releases" page](https://github.com/JetBrains/RiderSourceCodeAccess/releases) and download version of plugin for your version of Unreal Engine;
2. Unzip `RiderSourceCodeAccess.zip` to `RiderSourceCodeAccess` folder;
3. Copy `RiderSourceCodeAccess` folder to `{UnrealEngineRoot}/Engine/Plugins/Developer`;
a. If `{UnrealProjectRoot}/Plugins/Developer` does not exist, create it;
4. Re-generate solution files - uproject file > context menu > Generate Visual Studio project files;
5. Build UE project using Rider or Visual Studio;
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.

### Project is downloaded from Epic Games Store
1. Go to ["Releases" page](https://github.com/JetBrains/RiderSourceCodeAccess/releases) and download version of plugin for your version of Unreal Engine;
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. Re-generate solution files - uproject file > context menu > Generate Visual Studio project files;
5. Build UE project using Rider or Visual Studio;
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.
2 changes: 1 addition & 1 deletion RiderSourceCodeAccess.uplugin
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"FileVersion": 3,
"Version": 2,
"EngineVersion": "4.22.0",
"EngineVersion": "4.21.0",
"VersionName": "1.0",
"FriendlyName": "Rider Integration",
"Description": "Allows access to source code in Rider.",
Expand Down

0 comments on commit d5469e2

Please sign in to comment.