Tutorial docu

This commit is contained in:
Yannik Schmidt
2021-09-08 08:57:53 +02:00
committed by GitHub
parent 406110704d
commit dab51f169c

16
Tutorial.md Normal file
View File

@@ -0,0 +1,16 @@
# Relevant Files in
## /Content/Dialog/Wreckages
- DisplayStoryOrMessage -> BT-Task to show tutorial, tick the isTutorial-parameter and enter the tutorial Name, the tutorial name is both title of the created window and key for both the video-media-map in the tutorial widgt and the key for the styled displayed text saved in the string table
## /Content/UI/Tutorials/
- TutorialRichtTextStyle -> Styling Tags
- TutorialText -> String Table with styled tutorial texts
- Tutorial (Widget) Main Tutorial Widget spawned by BT-Task
## How to create a new Tutorial
- Add the relevant video file to /project_root/Video_Raw/
- Drag it into /Game/UI/Tutorials/Videos/ to create a media reference
- Verify it's playable in the tutorial media manager in /Game/UI/Tutorials
- Add a string table text to the TutorialTextStringTable in /Game/UI/Tutorials/, mind that the key will also be the title of the window
- Add the same key to the MediaSourceMap-Variable in the Tutorial-Widget (/Game/UI/Tutorials/Tutorial) and reference the media reference for this key