Skip to content

Commit e2a2ddf

Browse files
committed
Add migration guide
1 parent 876ba0a commit e2a2ddf

File tree

2 files changed

+57
-0
lines changed

2 files changed

+57
-0
lines changed

docs/support/migrate.mdx

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
---
2+
id: migrate
3+
title: Migrate to EOS Online Framework
4+
description: Learn how to migrate your project from Online Subsystem Blueprints and Matchmaking plugins to the EOS Online Framework.
5+
---
6+
7+
If you previously used the Online Subsystem Blueprints or Matchmaking plugins, and are now upgrading to the EOS Online Framework, you'll need to migrate your project.
8+
9+
## Close the editor
10+
11+
Close the editor if it is already open.
12+
13+
## Backup your project!
14+
15+
Make a complete backup of your project before proceeding.
16+
17+
## Download the EOS Online Framework plugin
18+
19+
If you haven't already done so, [download the EOS Online Framework plugin via Fab or GitLab](../index.mdx#install-the-plugin).
20+
21+
## Add the EOS Online Framework plugin to your project
22+
23+
If you didn't have "EOS Online Subsystem" previously enabled in your project, you'll need to add the EOS Online Framework now. Open your `.uproject` file in a text editor, and add the following entry to the `Plugins` array in your `.uproject` file.
24+
25+
```json
26+
{
27+
"Name": "OnlineSubsystemRedpointEOS",
28+
"Enabled": true,
29+
"MarketplaceURL": "com.epicgames.launcher://ue/marketplace/product/2c92594ce5aa416c8bfbd79275389e3b"
30+
}
31+
```
32+
33+
Please note that entries in the `Plugins` array need to be separated by commas (`,`). There must not be a comma between the last entry and the closing square bracket (`]`).
34+
35+
## Turn off the Online Subsystem Blueprints and Matchmaking plugins in your project
36+
37+
The functionality of the Online Subsystem Blueprints and Matchmaking plugins are now included in EOS Online Framework. Leaving them enabled will cause a conflict when you try to load your project, so turn them off now.
38+
39+
Open your `.uproject` in a text editor, and change `Enabled` to `false` for Online Subsystem Blueprints and Matchmaking:
40+
41+
```json
42+
{
43+
"Name": "OnlineSubsystemBlueprints",
44+
"Enabled": false
45+
},
46+
{
47+
"Name": "Matchmaking",
48+
"Enabled": false
49+
},
50+
```
51+
52+
## Open your project
53+
54+
Save your changes to your `.uproject` file and open the project in the editor again. Everything should load correctly.
55+
56+
If you experience issues with the migration steps, please [reach out to support](../index.mdx).

sidebars.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ module.exports = {
2020
support: [
2121
"support/index",
2222
"support/clone_from_gitlab",
23+
"support/migrate",
2324
{
2425
type: "category",
2526
label: "Troubleshooting",

0 commit comments

Comments
 (0)