A library that makes creating interactive tutorials extremely simple. It handles both displaying the tutorials and saving the user progress in them.
| Name | Description |
|---|---|
| .RegisterTutorials(id, data) | Registers a new tutorial with the given ID. |
| .TriggerTutorial(id, index [,maxAdvance]) | Advances a step in a given tutorial and unlocks progression up to index. |
| .ResetTutorials(id) | Resets progression in a given tutorial. |
| .GetTutorials(id) | Returns data originally registered for a given tutorial. |
| :Embed(object) | Embeds the above methods into the given object. |
:Embed(object) use a dot . syntax, instead of the more common : syntax.
First of all, you must register the new tutorial for you addon:
Lib.RegisterTutorials("MyAddon", {
savedvariable = "MyAddon_TutorialsSavedVariable",
title = "MyAddons",
{ -- This is tutorial #1
text = "Hello",
image = "SomeImage",
},
{ -- Tutorial #2
text = "Bye",
}
})
Finally, you need to tell the library when you want the tutorial to be shown. If you provided the savedvariable argument, you won't have to worry about which panels the user has already seen neither to save that information. CustomTutorials will handle that for you:
-- Shows up to panel #3 if the user has not seen it already
MyAddon:TriggerTutorial(3)
If you use this library, please list it as one of your dependencies in the CurseForge admin system. It's a big help! 👍