Skip to content

Commit 136a129

Browse files
committed
Document required known changes to Lyra for Redpoint EOS compatibility
1 parent 0cba2bd commit 136a129

5 files changed

Lines changed: 30 additions & 5 deletions

File tree

docs/changelog/2022/_index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -228,7 +228,7 @@ This release fixes several issues:
228228

229229
- Fixed an issue that prevented Epic from publishing a macOS build of the plugin for Unreal Engine 5.0. Once Epic publishes this update, the plugin should be downloadable in the Epic Games Launcher on macOS again.
230230
- Fixed a crash that could occur on consoles in Unreal Engine 4.26 and 4.27, due to new Unreal Engine 5.0 compatibility code that was added.
231-
- Added documentation on how to access the [new Lyra example for Redpoint's EOS Online Framework](/docs/examples/lyra.mdx#accessing-the-lyra-example-project). This is a preconfigured version of Lyra set up to use the Redpoint EOS Online Framework plugin instead of Epic's implementation.
231+
- Added documentation on how to access the [new Lyra example for Redpoint's EOS Online Framework](/docs/examples/lyra/index.mdx#accessing-the-lyra-example-project). This is a preconfigured version of Lyra set up to use the Redpoint EOS Online Framework plugin instead of Epic's implementation.
232232
- Fixed a compatibility issue with Lyra when it uses long bucket IDs for sessions. Bucket IDs are now automatically limited to 60 characters to match the backend limits, and a warning is printed if the provided bucket ID is too long and cut to 60 characters.
233233
- Fixed a compatibility issue with Lyra to permit float attributes when updating or creating sessions. They will still be read as doubles when reading session data, but this allows you to submit them as floats.
234234
- Fixed a compatibility issue with Lyra where it would attempt a session search with the magic `SEARCH_PRESENCE` and `SEARCH_LOBBIES` filters, where it does not also specify attributes with those names. These special search filters are only used by the Steam and Epic EOS implementations, so the fix in the Redpoint plugin is to simply ignore these search filter when they are provided.

docs/changelog/2025/07.14/_index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
This release improves support for Google Play on Android and fixes several issues:
44

55
- [Minute of Mayhem](/docs/examples/minute/index.mdx) now includes an example of e-commerce on Google Play. We'll expand the "in-game store" of Minute of Mayhem to support e-commerce on other platforms in the future.
6-
- [Lyra](/docs/examples/lyra.mdx) has been updated for Unreal Engine 5.6.
6+
- [Lyra](/docs/examples/lyra/index.mdx) has been updated for Unreal Engine 5.6.
77
- Updated the Google Play billing library to 8.0.0, and added support for non-consumable purchases on Android.
88
- To consume a purchase on Android, pass `consume` as the "Receipt Info" argument when finalizing the receipt.
99
- To acknowledge a purchase without consuming it on Android, pass `acknowledge` as the "Receipt Info" argument when finalizing the receipt.

docs/examples/lyra/changes.mdx

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
title: Compatibility changes in Lyra for Redpoint EOS
3+
description: Learn about the configuration and code changes you need to use Redpoint EOS with Lyra.
4+
---
5+
6+
If you are adopting Redpoint EOS into an existing Lyra project, or you're using a newer version of Lyra than what we have available in our example repository, you may need to apply the following code and configuration changes to make things work correctly:
7+
8+
# Turn off beacon usage
9+
10+
Lyra makes some assumptions about beacons that are specific to the Epic EOS plugin implementation. You need to turn them off in order for connections to work with Redpoint EOS.
11+
12+
In your `DefaultEngine.ini` file:
13+
14+
```
15+
[/Script/CommonUser.CommonSessionSubsystem]
16+
bUseBeacons=false
17+
18+
[/Script/OnlineSubsystemUtils.PartyBeaconHost]
19+
bIsValidationStrRequired=false
20+
```
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,14 @@ description: Use our modified version of Lyra that is tailored for Epic Online S
66

77
import Button from "@site/src/Button";
88

9-
![Lyra screenshot](./img/lyra.png)
9+
![Lyra screenshot](../img/lyra.png)
1010

1111
We offer a modified version of the Lyra example project that Epic Games provides, configured to use Redpoint's EOS Online Framework instead. Unlike the default Lyra example, you don't need to build Unreal Engine from source in order to enable EOS.
1212

1313
:::warning
1414
We don't recommend Lyra to new developers. It requires knowledge of C++, and does not demonstrate Redpoint EOS Online Framework features that make implementing multiplayer games easier, including team matchmaking.
1515

16-
For an example project tailored to Epic Online Services, we recommend starting with [Minute of Mayhem](./minute/index.mdx) instead.
16+
For an example project tailored to Epic Online Services, we recommend starting with [Minute of Mayhem](../minute/index.mdx) instead.
1717
:::
1818

1919
### Accessing the Lyra example project

sidebars.js

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,12 @@ module.exports = {
1010
"examples/minute/player-preferences",
1111
],
1212
},
13-
"examples/lyra",
13+
{
14+
type: "category",
15+
label: "Lyra",
16+
link: { type: "doc", id: "examples/lyra/index" },
17+
items: ["examples/lyra/changes"],
18+
},
1419
],
1520
framework: [
1621
"framework/index",

0 commit comments

Comments
 (0)