Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stomt/stomt-unreal-plugin
Collect feedback in-game/in-app with STOMT for Unreal Engine.
https://github.com/stomt/stomt-unreal-plugin
blueprint community crm crm-system feedback feedback-loop feedback-submission feedback-systems game mass-relationship-management plugin stomt ue4 ue4-modules unreal unreal-engine unrealengine unrealscript widget
Last synced: 2 months ago
JSON representation
Collect feedback in-game/in-app with STOMT for Unreal Engine.
- Host: GitHub
- URL: https://github.com/stomt/stomt-unreal-plugin
- Owner: stomt
- License: mit
- Created: 2015-10-19T15:25:13.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2021-01-29T16:16:46.000Z (almost 4 years ago)
- Last Synced: 2024-10-24T02:34:36.176Z (3 months ago)
- Topics: blueprint, community, crm, crm-system, feedback, feedback-loop, feedback-submission, feedback-systems, game, mass-relationship-management, plugin, stomt, ue4, ue4-modules, unreal, unreal-engine, unrealengine, unrealscript, widget
- Language: C++
- Homepage: https://stomt.co/unreal
- Size: 671 MB
- Stars: 27
- Watchers: 11
- Forks: 8
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# 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](https://github.com/stomt/stomt-unreal-plugin/tree/UE/4.16),
[4.17](https://github.com/stomt/stomt-unreal-plugin/tree/UE/4.17),
[4.18](https://github.com/stomt/stomt-unreal-plugin/tree/UE/4.18),
[4.19](https://github.com/stomt/stomt-unreal-plugin/tree/UE/4.19),
[4.20](https://github.com/stomt/stomt-unreal-plugin/tree/UE/4.20),
[4.21](https://github.com/stomt/stomt-unreal-plugin/tree/UE/4.21),
[4.22](https://github.com/stomt/stomt-unreal-plugin/tree/UE/4.22),
[4.23](https://github.com/stomt/stomt-unreal-plugin/tree/UE/4.23),
[4.24](https://github.com/stomt/stomt-unreal-plugin/tree/UE/4.24),
[4.25](https://github.com/stomt/stomt-unreal-plugin/tree/UE/4.25),
[4.26](https://github.com/stomt/stomt-unreal-plugin/tree/UE/4.26)
)**
This SDK allows the easy integration of the feedback solution [www.stomt.com](https://www.stomt.com/) in your Unreal apps and games.
## Use-Cases
Example Games that use our integrations:
* [Empires of the Undergrowth](https://www.stomt.com/empires-of-the-undergrowth)
* [All Walls Must Fall](https://www.stomt.com/AWMF)
* [Pantropy](https://www.stomt.com/pantropy)
## Installation
### Installation via Marketplace (recommended)
1. [Download](com.epicgames.launcher://ue/marketplace/content/7980672d57664bb5a567ff39f5106af6) the Plugin via the [Unreal Engine Marketplace](https://www.unrealengine.com/marketplace/stomt-collect-feedback-community-building)
2. Enable StomtPlugin in your Plugins Window (in Unreal Editor: `Edit -> Plugins -> Installed -> Widgets -> StomtPlugin`)
3. Enable "Show Engine Content" and "Show Plugin Content" in your Content Browser
4. Find StomtPlugin Content
5. Place the `ExampleActor` in your scene.
6. 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)._
### Manual Installation
_If you use an older Unreal Engine version please check out the [`UE/[version]` branch](https://github.com/stomt/stomt-unreal-plugin/branches)._
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](https://docs.unrealengine.com/latest/INT/Programming/QuickStart/2/index.html)
2. Add the StomtPlugin to your projects `PublicDependencyModuleNames` in the projects `build.cs`. `/Source/[YourProjectName]/[YourProjectName].Build.cs`:
```c++
PublicDependencyModuleNames.AddRange(new string[] { "StomtPlugin" }); // Add "StomtPlugin" String
```
3. Restart Unreal Editor, open your project and enable the plugin. `Edit -> Plugins -> Widgets -> StomtPlugin`
4. Check `Show Plugin Content` and `Show Engine Content` in the bottom right corner of your editor (view options).
5. Place the `ExampleActor` in your scene.
6. 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)._
## Configuration
1. Create a page for your game on [www.stomt.com](https://www.stomt.com/signup/game).
2. Create an [App Id](https://www.stomt.com/integrate) for Unreal.
3. Enter the `App Id` into the `ExampleActor` Blueprint:
**You can disable the screenshot and log-upload functionality**
4. 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)](https://imgur.com/5SoQzfj)
* Put a button into the HUD [(Example)](https://imgur.com/t9wPpJj)
* Only show the button to certain players (e.g. power users)
* Trigger the form after certain events
**Define a hotkey:**
## Event-Callbacks
The STOMT Widget supports a variety of callback 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.
**Easily add an array of labels**
## Issues
Don't hesitate to [contact](https://www.stomt.com/stomt-unreal-engine-plugin) us if you have any issues or need help.
## Versioning
We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/stomt/stomt-unreal-plugin/tags).
## Contribution
We would love to see you contributing to this project. Please read [CONTRIBUTING.md](https://github.com/stomt/stomt-unreal-plugin/blob/master/CONTRIBUTING.md) for details on our code of conduct, and the process for submitting pull requests to us.
Visit the [project on STOMT](https://www.stomt.com/stomt-unreal-plugin) to support with your ideas, wishes and feedback.
## Authors
[Daniel Schukies](https://github.com/daniel-schukies) | [Follow Daniel Schukies on STOMT](https://www.stomt.com/danielschukies)
See also the list of [contributors](https://github.com/stomt/stomt-unreal-engine-plugin/contributors) who participated in this project.
## More about stomt
*Regularly communicate your page on social channels and checkout our [Website-Widget](https://www.stomt.com/dev/js-sdk) for your websites to collect feedback from anywhere.*
* On the web [www.stomt.com](https://www.stomt.com)
* [STOMT for iOS](http://stomt.co/ios)
* [STOMT for Android](http://stomt.co/android)
* [STOMT for Unity](http://stomt.co/unity)
* [STOMT for Websites](http://stomt.co/web)
* [STOMT for Wordpress](http://stomt.co/wordpress)
* [STOMT for Drupal](http://stomt.co/drupal)