Skip to content

Commit 356d609

Browse files
hach-quehach-que
committed
Improve EOS SDK install guidance
1 parent fa6ed6a commit 356d609

8 files changed

Lines changed: 463 additions & 155 deletions

File tree

‎docs/examples/minute/configure.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Minute of Mayhem comes preconfigured with a product ID that we've already set up
88

99
## Set up a new product in the EOS Developer Portal
1010

11-
Follow our [getting started guide](../../setup/index.mdx#create-an-eos-product-in-the-developer-portal) to create a new EOS product in the developer portal, and continue following the guide until you have IDs to copy.
11+
Follow our [getting started guide](../../setup/index.mdx#create-a-product-in-the-epic-games-developer-portal) to create a new EOS product in the developer portal, and continue following the guide until you have IDs to copy.
1212

1313
## Update the project with new credentials
1414

‎docs/setup/index.mdx‎

Lines changed: 9 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@ description: Getting started with the EOS Online Framework plugin for Unreal Eng
44
slug: /
55
---
66

7-
import { DownloadPlugin, InstallSdk } from "@site/src/Welcome.tsx";
7+
import { DownloadPlugin } from "@site/src/Welcome.tsx";
8+
import { InstallSdk } from "@site/src/components/InstallSdk";
89

910
This guide will walk you through the process of installing the EOS Online Framework plugin, and configuring your project for Epic Online Services.
1011

@@ -16,54 +17,24 @@ If you want to use precompiled versions of the plugin, or you want to use the pl
1617

1718
<DownloadPlugin />
1819

19-
### Installing from GitLab (optional)
20+
## Create a product in the Epic Games Developer Portal
2021

21-
If you would like early access to fixes and features before they're released on Fab, you can download the Paid Edition of the plugin from [the Redpoint Games GitLab instance](https://src.redpoint.games). You must install from GitLab if you are developing for console platforms.
22+
Before you can download the EOS SDK or use EOS Online Framework in your game, you'll need to create a product in the Epic Games Developer Portal. This will also provide you with the various IDs and secrets you need to later enter into Project Settings.
2223

23-
1. Verify your license on the [License Manager](https://licensing.redpoint.games/).
24-
2. Once your license has been verified, you'll be able to access the [EOS Online Framework](https://src.redpoint.games/redpointgames/eos-online-framework/) repository.
25-
3. Add your [SSH key](https://src.redpoint.games/-/user_settings/ssh_keys) or [create an access token for accessing Git over HTTPS](https://src.redpoint.games/-/user_settings/personal_access_tokens).
26-
4. Clone the plugin with Git to the `Plugins/EOS` directory underneath your project folder:
27-
- Via SSH: `git clone git@src.redpoint.games:redpointgames/eos-online-framework.git Plugins/EOS`
28-
- Via HTTPS: `git clone https://src.redpoint.games/redpointgames/eos-online-framework/ Plugins/EOS`
29-
30-
If you have installed the plugin from GitLab, it is recommended that you uninstall the version installed via Fab.
31-
32-
If you are unfamiliar with Git, a [more in-depth guide can be found here](../support/clone_from_gitlab.mdx).
24+
1. Sign into the [Epic Games Developer Portal](https://dev.epicgames.com/portal). If prompted, select the organisation that your game should be created under.
25+
1. On the sidebar, click **Create Product**.
26+
1. Give your product a name. You can change this later, so don't feel like you need to pick a final name right now.
27+
1. When prompted, skip adding a cover image for your product. You can add one later.
28+
1. You'll now see your new product in the sidebar and on the main screen.
3329

3430
## Installing the EOS SDK
3531

36-
:::info
37-
Skip this step if you installed the plugin via Fab.
38-
:::
39-
4032
<InstallSdk />
4133

42-
## Enter your license key (Free Edition only)
43-
44-
If you are using the Free Edition, you will be provided with a license key from the [Redpoint Games License Manager](https://licensing.redpoint.games). When you've installed the plugin in your project, you'll need to set the license key. You can do that either by setting the license key in the `DefaultEngine.ini` file, or by changing it through "Project Settings".
45-
46-
This does not apply to Paid Edition users.
47-
48-
```ini
49-
[EpicOnlineServices]
50-
FreeEditionLicenseKey=...
51-
```
52-
5334
## Using the example projects
5435

5536
This guide can be used to set up your own new or existing Unreal Engine project, or to set up the [example project](../examples/minute/index.mdx) with your own EOS product ID.
5637

57-
## Create an EOS product in the Developer Portal
58-
59-
Before you can use EOS Online Framework, you need to create a product in the Epic Games Developer Portal. This will provide you with the various IDs and secrets you need to enter into Project Settings.
60-
61-
1. Sign into the [Epic Games Developer Portal](https://dev.epicgames.com/portal). If prompted, select the organisation that your game should be created under.
62-
1. On the sidebar, click **Create Product**.
63-
1. Give your product a name. You can change this later, so don't feel like you need to pick a final name right now.
64-
1. When prompted, skip adding a cover image for your product. You can add one later.
65-
1. You'll now see your new product in the sidebar and on the main screen.
66-
6738
## Create the client ID and secret for your product
6839

6940
To authenticate your game with the EOS backend, you need to create a client ID and secret for your product.

‎docs/support/additional_sdk_install_locations.mdx‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
title: Additional search locations for the EOS SDK
3+
description: A list of additional locations that the Redpoint EOS Online Framework plugin will look in to find the EOS SDK.
4+
---
5+
6+
In addition to the [recommended installation location for the EOS SDK](../setup/index.mdx#installing-the-eos-sdk) mentioned in the getting started guide, the plugin will also search the following locations:
7+
8+
- `C:\Users\<username>\Downloads\EOS-SDK-(Version)`
9+
- `C:\ProgramData\EOS-SDK-(Version)`
10+
- `C:\EOS-SDK-(Version)`
11+
- `/Users/<username>/Downloads/EOS-SDK-(Version)`
12+
13+
A full list of search locations can be found in the `Source\RedpointEOSSDK\RedpointEOSSDKInfo.json` file included in the plugin.
14+
15+
:::danger
16+
We don't recommend using the locations above, as it will mean each team member needs to install the EOS SDK locally. You should place the EOS SDK in your project's `Plugins` directory as recommended by the setup guide, and check the EOS SDK into your source control system.
17+
:::

‎sidebars.js‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,7 @@ module.exports = {
4949
],
5050
},
5151
"support/advanced_configuration",
52+
"support/additional_sdk_install_locations",
5253
"support/gameplay_debugger",
5354
"support/console_commands",
5455
"support/console_variables",

‎src/EOSVersion.tsx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import * as React from "react";
22
import { useState, useEffect } from "react";
33

4-
const EOSContext = React.createContext("...");
4+
export const EOSContext = React.createContext("...");
55

66
export function EOSVersionResolver(props) {
77
const [status, setStatus] = useState("fetching");

‎src/Welcome.tsx‎

Lines changed: 24 additions & 115 deletions
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,17 @@ export function DownloadPlugin() {
99
return (
1010
<div className="row">
1111
<div className="col">
12-
<div className="card">
12+
<div className="card" style={{ marginBottom: "1em" }}>
1313
<div className="card__header">
1414
<h3>Paid Edition</h3>
1515
</div>
1616
<div className="card__body">
17-
You can install the plugin through the Epic Games Launcher.
17+
<p style={{ marginBottom: "var(--ifm-paragraph-margin-bottom)" }}>
18+
You can install the plugin through the Epic Games Launcher, or get
19+
early access to fixes and features via the Redpoint GitLab.
20+
</p>
21+
✅ Includes exclusive features such as team-based matchmaking,
22+
professional support and source code.
1823
</div>
1924
<div className="card__footer">
2025
<a
@@ -24,6 +29,14 @@ export function DownloadPlugin() {
2429
>
2530
View on Fab
2631
</a>
32+
<a
33+
className="button button--secondary button--block"
34+
href="/docs/support/clone_from_gitlab"
35+
target="_blank"
36+
style={{ marginTop: "0.5em" }}
37+
>
38+
Install via Redpoint GitLab
39+
</a>
2740
</div>
2841
</div>
2942
</div>
@@ -33,14 +46,20 @@ export function DownloadPlugin() {
3346
<h3>Free Edition</h3>
3447
</div>
3548
<div className="card__body">
36-
Download the ZIP file for the latest stable version of Unreal
37-
Engine.
49+
<p style={{ marginBottom: "var(--ifm-paragraph-margin-bottom)" }}>
50+
Download the ZIP file for the latest version of Unreal Engine, via
51+
the Redpoint License Manager.
52+
</p>
53+
⚠️ The Free Edition only supports the latest version of Unreal
54+
Engine. If you need support for an older Unreal Engine version,
55+
you'll need to use the Paid Edition instead.
3856
</div>
3957
<div className="card__footer">
4058
<a
41-
className="button button--success button--block"
59+
className="button button--secondary button--block"
4260
href="https://licensing.redpoint.games/get/eos-online-subsystem-free/"
4361
target="_blank"
62+
style={{ minHeight: "5.5em", paddingTop: "2em" }}
4463
>
4564
Download now
4665
</a>
@@ -50,113 +69,3 @@ export function DownloadPlugin() {
5069
</div>
5170
);
5271
}
53-
54-
export function InstallSdk() {
55-
return (
56-
<EOSVersionResolver>
57-
<p>
58-
If you are not using the Paid Edition installed through Fab, you will
59-
need to download and unzip the EOS SDK in one of the following supported
60-
locations. You can download the EOS SDK from the Epic Games developer
61-
portal.
62-
</p>
63-
<Admonition type="warning">
64-
The Free Edition currently requires{" "}
65-
<strong>
66-
<EOSVersion />
67-
</strong>
68-
. If you can't download this version from the Epic Games developer
69-
portal, you will either need to wait until the Free Edition is updated
70-
to be compatible with the latest version, or purchase the Paid Edition
71-
(which includes the required EOS SDK for you).
72-
</Admonition>
73-
<p>
74-
You need to extract the ZIP into a folder with a matching name. For
75-
example, if you were installing SDK <CodeWithEOSSuffix />, you would
76-
extract it to one of the following locations.{" "}
77-
<strong>
78-
Substitute the version number in the folder path for the version
79-
number of the SDK you are using.
80-
</strong>
81-
</p>
82-
<ul>
83-
<li>
84-
<CodeWithEOSSuffix>
85-
&lt;project&gt;\Plugins\EOS-SDK-
86-
</CodeWithEOSSuffix>
87-
</li>
88-
<li>
89-
<CodeWithEOSSuffix>
90-
C:\Users\&lt;username&gt;\Downloads\EOS-SDK-
91-
</CodeWithEOSSuffix>
92-
</li>
93-
<li>
94-
<CodeWithEOSSuffix>C:\ProgramData\EOS-SDK-</CodeWithEOSSuffix>
95-
</li>
96-
<li>
97-
<CodeWithEOSSuffix>C:\EOS-SDK-</CodeWithEOSSuffix>
98-
</li>
99-
<li>
100-
<CodeWithEOSSuffix>
101-
/Users/&lt;username&gt;/Downloads/EOS-SDK-
102-
</CodeWithEOSSuffix>
103-
</li>
104-
</ul>
105-
<p>
106-
If you need iOS support, you can download the EOS iOS SDK from the Epic
107-
Games developer portal and extract it in one of the following locations:
108-
</p>
109-
<ul>
110-
<li>
111-
<CodeWithEOSSuffix>
112-
&lt;project&gt;\Plugins\EOS-SDK-IOS-
113-
</CodeWithEOSSuffix>
114-
</li>
115-
<li>
116-
<CodeWithEOSSuffix>
117-
C:\Users\&lt;username&gt;\Downloads\EOS-SDK-IOS-
118-
</CodeWithEOSSuffix>
119-
</li>
120-
<li>
121-
<CodeWithEOSSuffix>C:\ProgramData\EOS-SDK-IOS-</CodeWithEOSSuffix>
122-
</li>
123-
<li>
124-
<CodeWithEOSSuffix>C:\EOS-SDK-IOS-</CodeWithEOSSuffix>
125-
</li>
126-
<li>
127-
<CodeWithEOSSuffix>
128-
/Users/&lt;username&gt;/Downloads/EOS-SDK-IOS-
129-
</CodeWithEOSSuffix>
130-
</li>
131-
</ul>
132-
<p>
133-
If you need Android or Quest support, you can download the EOS Android
134-
SDK from the Epic Games developer portal and extract it in one of the
135-
following locations:
136-
</p>
137-
<ul>
138-
<li>
139-
<CodeWithEOSSuffix>
140-
&lt;project&gt;\Plugins\EOS-SDK-Android-
141-
</CodeWithEOSSuffix>
142-
</li>
143-
<li>
144-
<CodeWithEOSSuffix>
145-
C:\Users\&lt;username&gt;\Downloads\EOS-SDK-Android-
146-
</CodeWithEOSSuffix>
147-
</li>
148-
<li>
149-
<CodeWithEOSSuffix>C:\ProgramData\EOS-SDK-Android-</CodeWithEOSSuffix>
150-
</li>
151-
<li>
152-
<CodeWithEOSSuffix>C:\EOS-SDK-Android-</CodeWithEOSSuffix>
153-
</li>
154-
<li>
155-
<CodeWithEOSSuffix>
156-
/Users/&lt;username&gt;/Downloads/EOS-SDK-Android-
157-
</CodeWithEOSSuffix>
158-
</li>
159-
</ul>
160-
</EOSVersionResolver>
161-
);
162-
}

0 commit comments

Comments
 (0)