CustomTutorials-2.0

This library makes easy the creation of custom tutorials for your addons. It provides the following API:

• .RegisterTutorials(id, data)
• .TriggerTutorial(id, index, force)
• .ResetTutorials(id)
• .GetTutorials(id)

Accessing

The easiest way to access CustomTutorials methods is to embed them into your addon object:

local Tutorials = LibStub("CustomTutorials-2.0")
Tutorials:Embed(MyObject)

But you may also set CustomTutorials as a local variable and call the methods directly.

Tutorials.RegisterTutorials("MyTutorial", {
  -- data goes here
})

Registering

First of all, you must register the new tutorials for you addon:

MyAddon:RegisterTutorials({
  savedvariable = "MyAddon_TutorialsSavedVariable",
  title = "MyAddons",
  {  -- This is tutorial #1
    text = "Hello",
    image = "SomeImage",
  },
  {  -- Tutorial #2
    text = "Bye",
  }
})

Currently, these are the arguments supported for the registering table (General) and for each tutorial (all of them are optional):

Triggering

Finally, you need to tell CustomTutorials when you want the tutorials to be shown. If you provided the savedvariable argument, you won't have to worry about which ones the user has already seen neither to save that information. CustomTutorials will handle that for you:

-- Shows up to tutorial #3 if the user has not seen it already
MyAddon:TriggerTutorial(3)

-- Shows tutorial #3. Yeah, you forced it.
MyAddon:TriggerTutorial(3, true)

Example

This example registers 3 tutorials; shows tutorial #1 when the user loads the addon for the first time; shows tutorials #2 and #3 when MyAddon_OnSomeEvent is called for the first time; and allows the user to see the tutorials again when MyAddon_OnHelpRequest is called.

MyAddon:RegisterTutorials( {
  savedvariable = "MyAddon_TutorialsState",
  {
    text = "Welcome to MyAddon",
    shine = MyAddon,
  },
  {
    text = "This is helpfull",
  },
  {
    text = "I hope you enjoyed this tutorial example.",
    image = 'ByeImage',
  },
})

function MyAddon_OnInitialize()
  -- Show welcome
  MyAddon:TriggerTutorial(1)
end

function MyAddon_OnSomeEvent()
  -- Show #2 and unlock #3
  MyAddon:TriggerTutorial(3)
end

function MyAddon_OnHelpRequest()
  -- Show tutorials again when the user asks
  MyAddon:TriggerTutorial(1, true)
end