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 )
This SDK allows the easy integration of the feedback solution www.stomt.com in your Unreal apps and games.
Example Games that use our integrations:
-
Download the Plugin via the Unreal Engine Marketplace
-
Enable StomtPlugin in your Plugins Window (in Unreal Editor:
Edit -> Plugins -> Installed -> Widgets -> StomtPlugin)
- Enable "Show Engine Content" and "Show Plugin Content" in your Content Browser
- Find StomtPlugin Content
-
Place the
ExampleActorin your scene. -
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.
If you use an older Unreal Engine version please check out the UE/[version] branch.
- Clone or download this repository into your projects
Pluginsdirectory.
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
- Add the StomtPlugin to your projects
PublicDependencyModuleNamesin the projectsbuild.cs./Source/[YourProjectName]/[YourProjectName].Build.cs:
PublicDependencyModuleNames.AddRange(new string[] { "StomtPlugin" }); // Add "StomtPlugin" String-
Restart Unreal Editor, open your project and enable the plugin.
Edit -> Plugins -> Widgets -> StomtPlugin -
Check
Show Plugin ContentandShow Engine Contentin the bottom right corner of your editor (view options).
-
Place the
ExampleActorin your scene. -
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.
-
Create a page for your game on www.stomt.com.
-
Create an App Id for Unreal.
-
Enter the
App Idinto theExampleActorBlueprint:
You can disable the screenshot and log-upload functionality
- Add the
StomtWidgetBPto the viewport via script (ExampleActor) or in your main HUD (ExampleUI) as widget.
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:
The STOMT Widget supports a variety of callback events.
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.
Easily add an array of labels
Don't hesitate to contact us if you have any issues or need help.
We use SemVer for versioning. For the versions available, see the tags on this repository.
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.
Daniel Schukies | Follow Daniel Schukies on STOMT
See also the list of contributors who participated in this project.
Regularly communicate your page on social channels and checkout our Website-Widget for your websites to collect feedback from anywhere.