From dab51f169c95af48b70ad45a9035e007915fd5c5 Mon Sep 17 00:00:00 2001 From: Yannik Schmidt Date: Wed, 8 Sep 2021 08:57:53 +0200 Subject: [PATCH] Tutorial docu --- Tutorial.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 Tutorial.md diff --git a/Tutorial.md b/Tutorial.md new file mode 100644 index 0000000..1f8972f --- /dev/null +++ b/Tutorial.md @@ -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