OQUPIE UE4 Plugin | OQUPIE
OQUPIE 🔧 Developer Guide
OQUPIE UE4 Plugin

-> Download Link


⚡  OQUPIE UE4 Plugin_v1.0.0


Before Starting.

✓ A better environment for your customer to ask

  • If you use Unreal Engine 4 Plug-in to your game, gamers can easily access the customer portal and make inquiries without leaving the game.

✓ A better customer support experience with more information

  • The Unreal Engine 4 Plug-in allows you to collect not only customer inquiries, but also your PC environment, character information, and more.

💡   OQUPIE Unreal Engine 4 Plug-in does not include UI elements. Please create your own UI for the game.

  • UE4 Plugin is based on Unreal Engine v4.19.
  • OQUPIE UE4 Plug-in collects below information by default.
  • You can customize the parameters of information you want to collect.


Setting for Windows

Step.1 Activating Customer Portal and Generating Access Key and Secret Key

  • Activate Customer Portal you want to connect with UE4 Plug-in.
    1. Go to Settings > Brands > Select brand for UE4 Plug-in  
    2. Go to Channel settings > UE4 Plug-in 
    3. In case of an inactive customer portal, click Go to activation →  and activate the customer portal
    4. Check customer portal URL that you want to send information to

  • Check your access key and secret key for authentication of UE4 Plug-in.
    1. Go toBrands > Select brand for UE4 Plug-in > Channel settings > UE4 Plug-in 
    2. Click ‘Generate Access Key’, and check Access key and Secret key

  • Portal URL and access key are required in Step.3*.

Step.2 Create new project

  • Copy OQUPIE Plug-in into Plugins directory.

  • Add “OQUPIE” in Build.cs.

public class OQUPIESample : ModuleRules
 {
     public OQUPIESample(ReadOnlyTargetRules Target) : base(Target)
     {
         PCHUsage = PCHUsageMode.UseExplicitOrSharedPCHs;
     
         PublicDependencyModuleNames.AddRange(
            new string[] 
            {
                "Core",
                "CoreUObject",
                "Engine",
                "InputCore",
                "OQUPIE"
            }
        );
  • Add “OQUPIE” and “WebBrowserWidget” into uproject file.
{
     "FileVersion": 3,
     "EngineAssociation": "4.19",
     "Category": "",
     "Description": "",
     "Modules": [
         {
             "Name": "OQUPIESample",
             "Type": "Runtime",
             "LoadingPhase": "Default",
             "AdditionalDependencies": [
                 "Engine"
             ]
         }
     ],
     "Plugins": [
         {
             "Name": "OQUPIE",
             "Enabled": true
         },
         {
             "Name": "WebBrowserWidget",
             "Enabled": true
         }
     ]
 }
  • Create Visual Studio Project for UE4 version 4.19.

  • Open OQUJPIE.sln Visual Studio project file and proceed to compile.

Step.3 Setting Blueprint

  • Refer to WBP_OQUPIE_Sample.uasset (OQUPIE_UE4 Plugin_v1.zip > Content > UI)

  • URL that you get returned after calling Submit is the customer portal URL that you connected with the plug-in. The sample shows you how you get forwarded when Submit succeed.

  • Check parameters OQUPIE offers. ( You can check at *Step 1)

    • URL : Customer portal URL that you want to send information to
    • Access Key, Secret Key : Authentication information for UE4 Plug-in

  • Check parameters you have to set.

    • Extras : information you can customize. Use form as TMap

    • GameVersion : Game version

    • User Name : User name

    • User ID : User ID

    • Character Name : Game character name

    • Game Language : Game language setting

Information sample that is transfered to your OQUPIE


{
     "pcInfo":
     {
         "sdkVersion": "OQUPIE 1.0",
         "gameVersion": "1.0.0.1",
         "userName": "UserName1",
         "userID": "Player1",
         "characterName": "Character Name 1",
         "gameLanguage": "kr",
         "applicationLanguage": "en",
         "operatingSystem": "Windows 10 version 10.0.17134.1.768.64bit",
         "cpuModel": "Intel(R) Core(TM) i7-4790 CPU @ 3.60GHz",
         "systemMemorySize": 16,
         "graphicsDeviceName": "NVIDIA GeForce GTX 960",
         "graphicsMemorySize": 2,
         "graphicsShaderLevel": "D3D11",
         "graphicsFeatureLevel": "Direct3D 11+ (SM5)",
         "ipAddress": "115.188.253.22/192.168.1.70",
         "hddAvailable": "183.72GB/447.13GB",
         "windowMode": "Windowed",
         "windowResolution": "1920x1080",
         "soundDeviceName": "Speakers (Realtek High Definition Audio)",
         "extras":
         {
             "Key1": "Value1",
             "Key2": "Value2"
         }
     }
 }




💡  OQUPIE Unreal Engine 4 Plug-in does not include UI elements. Please create your own UI for the game.



Setting for Mac OS

Step.1 Activating Customer Portal and Generating Access Key and Secret Key

  • Activate Customer Portal you want to connect with UE4 Plug-in.

    1. Go to Settings > Brands > Select brand for UE4 Plug-in
    2. Go to Channel settings > UE4 Plug-in
    3. In case of an inactive customer portal, click Go to activation → and activate the customer portal
    4. Check customer portal URL that you want to send information to

  • Check your access key and secret key for authentication of UE4 Plug-in.

    1. Go to Brands > Select brand for UE4 Plug-in > Channel settings > UE4 Plug-in
    2. Click ‘Generate Access Key’, and check Access key and Secret key
  • Portal URL and access key are required in Step.3*

Step.2 Create new project

  • Copy OQUPIE Plug-in into Plugins directory.

  • Add “OQUPIE” in Build.cs.

public class OQUPIESample : ModuleRules
 {
     public OQUPIESample(ReadOnlyTargetRules Target) : base(Target)
     {
         PCHUsage = PCHUsageMode.UseExplicitOrSharedPCHs;
     
         PublicDependencyModuleNames.AddRange(
            new string[] 
            {
                "Core",
                "CoreUObject",
                "Engine",
                "InputCore",
                "OQUPIE"
            }
        );
  • Add “OQUPIE” and “WebBrowserWidget” into uproject file.
{
     "FileVersion": 3,
     "EngineAssociation": "4.19",
     "Category": "",
     "Description": "",
     "Modules": [
         {
             "Name": "OQUPIESample",
             "Type": "Runtime",
             "LoadingPhase": "Default",
             "AdditionalDependencies": [
                 "Engine"
             ]
         }
     ],
     "Plugins": [
         {
             "Name": "OQUPIE",
             "Enabled": true
         },
         {
             "Name": "WebBrowserWidget",
             "Enabled": true
         }
     ]
 }
  • Create Xcode Project for UE4 version 4.19.

  • Open .xcworkspace project file with Xcode and compile.


Step.3 Setting Blueprint

  • Refer to WBP_OQUPIE_Sample.uasset (OQUPIE_UE4 Plugin_v1.zip > Content > UI)

  • URL that you get returned after calling Submit is the customer portal URL that you connected with the plug-in. The sample shows you how you get forwarded when Submit succeed.

  • Check parameters OQUPIE offers. ( You can check at *Step 1)

    • URL : Customer portal URL that you want to send information to
    • Access Key, Secret Key : Authentication information for UE4 Plug-in

  • Check parameters you have to set.

    • Extras : information you can customize. Use form as TMap

    • GameVersion : Game version

    • User Name : User name

    • User ID : User ID

    • Character Name : Game character name

    • Game Language : Game language setting

  • Information sample that is transfered to your OQUPIE

    {
         "pcInfo":
         {
             "sdkVersion": "OQUPIE 1.0",
             "gameVersion": "1.0.0.1",
             "userName": "UserName1",
             "userID": "Player1",
             "characterName": "Character Name 1",
             "gameLanguage": "kr",
             "applicationLanguage": "en",
             "operatingSystem": "Windows 10 version 10.0.17134.1.768.64bit",
             "cpuModel": "Intel(R) Core(TM) i7-4790 CPU @ 3.60GHz",
             "systemMemorySize": 16,
             "graphicsDeviceName": "NVIDIA GeForce GTX 960",
             "graphicsMemorySize": 2,
             "graphicsShaderLevel": "D3D11",
             "graphicsFeatureLevel": "Direct3D 11+ (SM5)",
             "ipAddress": "115.188.253.22/192.168.1.70",
             "hddAvailable": "183.72GB/447.13GB",
             "windowMode": "Windowed",
             "windowResolution": "1920x1080",
             "soundDeviceName": "Speakers (Realtek High Definition Audio)",
             "extras":
             {
                 "Key1": "Value1",
                 "Key2": "Value2"
             }
         }
     }