# Plugin Installation

Let's get started with installing EOS Integration Kit into your projects, which would be the easiest step, hopefully.

# Marketplace Edition

Download Marketplace Edition

So firstly, if you are using the marketplace version, thanks for the purchase 🫡 If you have bought the plugin, go the Epic Launcher and follow the below steps ->

  1. Open Library in the Unreal Engine Section of the Epic Launcher

  1. Check Valut and install the plugin for the version you want to use

  1. Now open or create a project with the same Unreal Engine Version and go to the Plugins section.

  1. Enable the Plugin and Restart the Editor

Done, now you have the plugin ready and are ready to move to the next step 🤝

# Github Edition

Download GitHub Edition

While we do our best to ensure that the latest release is available in a pre-built format on GitHub, there may be times we are not able to update the release in a timely manner, or you may want to run the latest codebase outside of an official release. These steps will walk you through how to download the latest code changes and build your plugin from source.

  1. Download the latest source files from GitHub

  1. Once downloaded, open the file EOSIntegrationKit-main.zip and extract it into your Projects Plugins directory. Rename the file to EOSIntegrationKit

  1. Download the Epic Online Services SDK

The EOS SDK can be downloaded from the Epic Games Dev Portal

Once logged into the Dev Portal, click SDK & Release Notes

Then select the correct SDK Version

  1. Copy the SDK into the EOSIntegrationKit Plugin

Open the .zip file and extract the contents of the SDK folder into YourProject\Plugins\EOSIntegrationKit\Source\ThirdParty\EIKSDK

Open the Lib directory and copy the two .lib files

Paste them into to the Bin directory

  1. Generate Project Files

Follow step 4 in the Github Edition section to regenerate your project files.

  1. Build Project

Once you have done all the above steps, it's time to build your project.

Open up the .sln file that was generated in Step 5 and Visual Studio will open.

At the top, select 'Build' from the menu, and select Build Solution

If you have no other issues in your project, the solution should build with no issues or warning.

# Upgrade Notes

If you are upgrading from Plugin Version 3.1 to 3.2, you have to follow the below steps to ensure a smooth transition. The reason for this is that the plugin has been updated to use the latest EOS SDK version 1.16.2 and is a major update from the previous version. Release notes for the EOS SDK can be found here

  1. After you have added the latest plugin to your project, either from the Marketplace or GitHub, you will notice that your project settings have been reset. This is because we have moved to use new locations for the plugin settings to support the most awaited Version 4 of the plugin which will be released soon.

  2. To fix this, close the editor and open the DefaultEngine.ini file located in YourProject\Config and replace the contents with the following:

Item To Replace

[/Script/OnlineSubsystemEIK.EIKSettings]

With

[/Script/EOSIntegrationKit.EIKSettings]
  1. Now open the editor and go to the Edit menu and select Project Settings. You will notice that the plugin settings are now located under Game -> EOS Integration Kit
  2. If you are were earlier using the Android/IOS Settings, that now is made available under the 'Platform' section in the Artifact Settings. You can now use your Android/IOS settings from there.
  3. If you are using Voice Module, please follow the same steps as given in Step 4.

Done, now you have successfully upgraded your project to the latest version of the plugin.