Skip to content

Latest commit

 

History

History
168 lines (99 loc) · 7.36 KB

README.md

File metadata and controls

168 lines (99 loc) · 7.36 KB
Raw

Collect Feedback In-Game | STOMT for Unreal Engine 4

Implementation Time: ~20 Minutes (incl. Triggers)

Base Unreal Version: 4.20 (For specific versions visit: 4.16, 4.17, 4.18, 4.19, 4.20, 4.21, 4.22, 4.23, 4.24, 4.25, 4.26 )

STOMT Unreal Engine feedback integration

This SDK allows the easy integration of the feedback solution www.stomt.com in your Unreal apps and games.

Use-Cases

Example Games that use our integrations:

Installation

Installation via Marketplace (recommended)

  1. Download the Plugin via the Unreal Engine Marketplace

  2. Enable StomtPlugin in your Plugins Window (in Unreal Editor: Edit -> Plugins -> Installed -> Widgets -> StomtPlugin)

Enable StomtPlugin in Unreal Editor

  1. Enable "Show Engine Content" and "Show Plugin Content" in your Content Browser

Unhide the Engine Content in Unreal Editor

  1. Find StomtPlugin Content

Discover StomtPlugins Conent

  1. Place the ExampleActor in your scene.

  2. Click play to run the game and show the feedback widget by pressing E.

You should now see the feedback form window in your game. Try to toggle "I wish"/"I like" and send a test stomt to "My Game" (The default test target). Then continue with Configuration.

Manual Installation

If you use an older Unreal Engine version please check out the UE/[version] branch.

  1. Clone or download this repository into your projects Plugins directory.

1.2. If you do not use C++ code in project: use the Add New button in the editor and add a blank C++ class to your project. Guide

  1. Add the StomtPlugin to your projects PublicDependencyModuleNames in the projects build.cs. /Source/[YourProjectName]/[YourProjectName].Build.cs:
PublicDependencyModuleNames.AddRange(new string[] { "StomtPlugin" }); // Add "StomtPlugin" String

  1. Restart Unreal Editor, open your project and enable the plugin. Edit -> Plugins -> Widgets -> StomtPlugin

  2. Check Show Plugin Content and Show Engine Content in the bottom right corner of your editor (view options).

Events

  1. Place the ExampleActor in your scene.

  2. Click play to run the game and show the feedback widget by pressing E.

You should now see the feedback form window in your game. Try to toggle "I wish"/"I like" and send a test stomt to "My Game" (The default test target). Then continue with Configuration.

Configuration

  1. Create a page for your game on www.stomt.com.

  2. Create an App Id for Unreal.

  3. Enter the App Id into the ExampleActor Blueprint:

Unhide the Engine Content in Unreal Editor

You can disable the screenshot and log-upload functionality

STOMT Plugin configuraton

  1. Add the StomtWidgetBP to the viewport via script (ExampleActor) or in your main HUD (ExampleUI) as widget.

Form Triggers

The widget can be opened and closed whenever you want by using our trigger functions.

That allows you to:

  • Put a button into the main menu (Example)
  • Put a button into the HUD (Example)
  • Only show the button to certain players (e.g. power users)
  • Trigger the form after certain events

Define a hotkey:

STOMT Plugin Form Triggers

Event-Callbacks

The STOMT Widget supports a variety of callback events.

Events

In-Game Labeling

Labels will help you track down user issues. Append labels, as for example your game-version or the player position/level. You can either hardcode them in the Unity Inspector or use a script to add them in a flexible way based on the information you have.

Events

Easily add an array of labels

Events

Issues

Don't hesitate to contact us if you have any issues or need help.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Contribution

We would love to see you contributing to this project. Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Visit the project on STOMT to support with your ideas, wishes and feedback.

Authors

Daniel Schukies | Follow Daniel Schukies on STOMT

See also the list of contributors who participated in this project.

More about stomt

Regularly communicate your page on social channels and checkout our Website-Widget for your websites to collect feedback from anywhere.