Skip to content

Latest commit

 

History

History
77 lines (61 loc) · 5.08 KB

Walkthrough.md

File metadata and controls

77 lines (61 loc) · 5.08 KB
Raw

README.md

EOS Plugin for Unity Walkthrough

This document is meant to serve as a guide to our EOS Plugin for Unity demo scenes. Each scene is meant to showcase the implementation of a specific feature such as peer 2 peer communication, lobbies, or custom invites. Each scene has a few things in common: the login page, side bar, scene selection, and debug log.

Sidebar

The sidebar shows the current version, logged in account, framerate, readme, log copy button and exit button.

  • The README button will display the readme for the current scene
  • The Copy Log button copies the log from the log window
  • The Exit button closes the application

Debug Log

The Debug log provides a filterable on screen debug output

  • The gear icon hides/shows the debug log buttons
    • The 'Enter filter text...' field allows for text filters
    • The filter icon allows for filtering by specific levels for each type channel
    • The two arrows icon expands the log to fill the window
    • The eye icon hides/shows the log

Scene selection

The yellow dropdown in the top of the window allows the user to select which demo scene they would like to log into

There is a standard sample pack, and several extra packs in the EOS Unity Plugin. If a scene doesn't load, remember to import the wanted extra pack, and add them in the build settings

Login Page

The login menu allows the user to select which login method they would like to use through the dropdown in the center of the window. After logging in the user will be put into the selected demo scene. The login options are as follows:

  • Dev Auth: Uses Epic Games’ Developer Authentication Tool.

    1. Launch the Developer Authentication Tool.

    Dev Auth Tool

    1. Pick a port to use on the computer. 8888 is a good quick to type number that isn't usually used by a process.
    2. Log in with one's user credentials that are registered with Epic.
    3. Pick a username. This username will be used in the sample to log in.

  • Account Portal: Uses the Epic Games overlay and any of the connected account types.

    • An Epic Games Account
    • A Facebook account
    • A Xbox Live account
    • A PlayStation Network Account
    • A Nintendo Account
    • A Steam Account
    • An Apple ID

  • Persistent Auth: Uses Epic Game's Persisting User Login.

  • External Auth: Uses a web browser to login through an online account portal similar to the Account Portal option.

  • Connect: Uses the Connect Interface to login through one of the supported options.

    • Device Access Token: Uses a persistent access token based on the device, unattached to an account.
    • Steam Session Ticket
    • Steam App Ticket
    • Discord Access Token
    • Openid Access Token

For information about login methods per platform, see our documentation: Login Type by Platform.

Individual Scene Walkthroughs

Note

For more information about Epic Online Services (and information about other resources) checkout the Epic Developer Resources Documentation.