Sample Project
To run the sample project which showcases most of the EOS features, follow these steps:
-
Clone/Download the plugin repo
-
You cannot directly open the ./sample folder and run the project, because the plugin binaries are not included. To include the plugin binaries. Download the latest release from the Releases section and replace the existing
sample/addons/epic-online-services-godot
folder with the one from the Release (this includes the built shared libraries). See the Installation section for more information on how to install the plugin. -
Copy your credentials (
Product Id
,Sandbox Id
,Deployment Id
,Client Id
,Client Secret
) of your Epic Games "Product" from the Epic Games Dev Portal and paste them in./sample/Main.gd
script in the relevant sections. The encryption key is a random 64 character long string. These credentials need to be kept as private as possible. One way is to make sure to encrypt all scripts when exporting the final game. (See Compiling with script key encryption) -
Configure your Product on the EOS Dev Portal with the following configuration:
- In the
Client Policies
section inProduct Settings
, for the Client policy type chooseCustom policy
, enable theUser is required
and enable every features and action exceptConnect
(Trusted Server Required). This will allow the sample to access the different services provided by Epic Online Services. In your actual game, the client policy is important and you should give minimal permissions to features. - In the
Permissions
section ofEpic Account Services
, enable all three:Basic Profile
,Online Presence
andFriends
. - (Optional if you want some pre-made achievements)
In the
Achievements
section inGame Services
, use theBulk Import
option and import theHelloProduct.zip
file located atres://HelloProduct.zip
- Finally open the
./sample
folder in Godot.