Skip to main content

Project Settings Reference

EOSCore is configured in Project Settings > Plugins > EOSCore Plugin. The settings are saved in Config/DefaultEngine.ini under the section [/Script/OnlineSubsystemEOSCore.EOSCoreSettings].

EOS Configurations​

You can add several configurations, for example one for the client and one for a dedicated server. The plugin picks one when it starts:

  1. The configuration named by the -EOSConfig= command line argument, if it exists.
  2. Otherwise the configuration named by Default Configuration Name.

If no configuration matches, the plugin does not initialize and the log shows GetEOSConfig(): Did not find any EOS Configuration.

SettingDescription
Config NameName used by Default Configuration Name and -EOSConfig=
Product IdFrom the Developer Portal, Product Settings
Sandbox IdFrom the Developer Portal. Overridden by -epicsandboxid=
Deployment IdFrom the Developer Portal. Overridden by -epicdeploymentid=
Client IdClient created in Client & Policy Settings. Client ids start with xyz
Client SecretSecret of that client
Encryption KeyExactly 64 hexadecimal characters (a 256 bit key). Used to encrypt Player Data Storage files. The default value 1111… is only a placeholder, generate your own key before you ship
Enable RTCEnables the RTC (voice) interfaces. Turn it off if you don't use EOS voice
warning

The Client Secret is stored in DefaultEngine.ini and ships with your game. Use a client policy that only allows what the game client needs, and a separate configuration with its own client for servers.

General Settings​

Settingini keyDescription
Default Configuration NameDefaultConfigurationNameConfiguration used when -EOSConfig= is not set. Default DefaultConfig
Tick Budget In MillisecondsTickBudgetInMillisecondsTime budget for EOS work per tick. 0 means no limit
Scope FlagsScopeFlagsEpic Account permissions requested by the Login node. Must match the permissions of your application in the Developer Portal, see Scope Consent
iOS Client IdIOSClientIdClient Id used for the iOS login redirect, see iOS Setup
Android Client IdAndroidClientIdClient Id used for the Android login redirect, see Android Setup
Disable EOS OverlaybDisableEOSOverlayDisables the EOS overlay. Same as the -DisableEOSOverlay command line argument

ini-only Settings​

These keys are not shown in Project Settings. Add them to the same section in DefaultEngine.ini.

[/Script/OnlineSubsystemEOSCore.EOSCoreSettings]
; Set to false to disable the EOSCore Online Subsystem
bEnabled=true
; Folder the EOS SDK uses for its cache (ignored on Android)
OverrideCacheDir=D:/MyGameCache
; Log level of the EOS SDK's own messages (non-Shipping builds only)
SDKLogLevel=Warning
; Seconds EOS retries network tasks before they fail
TaskNetworkTimeoutSeconds=10
ini keyDefaultDescription
bEnabledtrueEnables the EOSCore Online Subsystem. The older sections [/Script/EOSCore.EOSCoreSettings] and [EOSCore] are still read if this key is missing
OverrideCacheDirUser folder /CacheDirCache folder for the EOS SDK. Android always uses the app's internal files folder
SDKLogLevelVeryVerboseOff, Fatal, Error, Warning, Info, Verbose or VeryVerbose. Lower it if the EOS SDK messages flood your log. Not used in Shipping builds, where SDK logging is off
TaskNetworkTimeoutSeconds10How long EOS retries a network task (for example a login while offline) before the callback fails
SectionKeyDescription
[OnlineSubsystem]DefaultPlatformService=EOSCoreMakes EOSCore the default Online Subsystem, see Configuring Online Subsystem
[EOSSDK]bHasProjectBinary=trueMakes the engine's EOS modules use the EOS SDK binary that ships with EOSCore
[Voice]bEnabled=trueNeeded for Voice Chat (OSS)