Bird is the Word

Enabling Hugin to cacaaw, one tutorial at a time!

This is a very small mod that allows you to add tutorials.

Why use this mod?

If you are making a modpack or wanting to add tutorials to other mods that add new content, this is for you!

Wait... Doesn't this do the same as RustyMods CustomTutorials?

Actually, no! In a nutshell:

CustomTutorials adds guide points to prefabs, like build pieces, workstations, etc.
BirdIsTheWord adds tutorials for game events, such as discovering a location or killing a creature.

What tutorials can be added?

You can add tutorials for the following events:

Finding a new location in the world.
Picking up a new item that gets added to your inventory.
Killing a creature or boss.

Example Use Cases

You could add tutorials for Yggdrah's DragonRiders mod when you craft your first dragon egg, showing the player how to hatch and raise the dragon.
You could add a tutorial after killing Fader, directing the player to the DeepNorth in your modpack and give clues on how to get there.
You could add a tutorial for finding a new location added by other mods, like those from Warpalicious.

Configuration

All configurations are done in the maxfoxgaming.birdistheword.yml file, which will be generated for you on first launch of the mod. It will come with three example tutorials, which are disabled by default.

Each entry requires the following:

Name: This is the name of the tutorial. It must be unique.
Enabled: Must be set to true for the custom tutorial to be added. Set to false to disable the tutorial.
Type: This must be set to one of the following:
- Kill: The tutorial will trigger after a creature is killed by a player.
- Item: The tutorial will trigger when an item enters a player's inventory.
- Location: The tutorial will trigger when a player discovers a location.
Munin: If false, the tutorial will be given by Hugin. If true it will be given by Munin.
Label: This is what appears in the side-panel of the compendium. For example, 'Hugin: Example Tutorial'.
Topic: This is title text of the tutorial (the orange text that appears over the main text body).
Text: This contains the main tutorial text.
Data: This field must be set depending on the tutorial's Type as follows:
- For Kill tutorials, the prefab name of the creature that the player must kill. Example: GoblinBrute.
- For Item tutorials, the prefab name of the item that needs to enter the player's inventory. Example: QueensJam.
- For Location tutorials, the prefab name of the location that the player must get in range of. Example: BogWitch_Camp.

Compatibility

This mod should be fully compatible with RustyMods CustomTutorials.

Contact Me (Bug Reports & Suggestions)

If you have any suggestions, or experience bugs / problems using this mod please get in touch with me on my Discord.

Installation (Manual Download)

Move the 'plugins' folder from the archive to your BepInEx folder.

Example Use Cases

You could add tutorials for Yggdrah's DragonRiders mod when you craft your first dragon egg, showing the player how to hatch and raise the dragon.

You could add a tutorial after killing Fader, directing the player to the DeepNorth in your modpack and give clues on how to get there.

You could add a tutorial for finding a new location added by other mods, like those from Warpalicious.

Configuration

Each entry requires the following:

Name: This is the name of the tutorial. It must be unique.

Enabled: Must be set to true for the custom tutorial to be added. Set to false to disable the tutorial.

Type: This must be set to one of the following:

Kill: The tutorial will trigger after a creature is killed by a player.
Item: The tutorial will trigger when an item enters a player's inventory.
Location: The tutorial will trigger when a player discovers a location.

Munin: If false, the tutorial will be given by Hugin. If true it will be given by Munin.

Label: This is what appears in the side-panel of the compendium. For example, 'Hugin: Example Tutorial'.

Topic: This is title text of the tutorial (the orange text that appears over the main text body).

Text: This contains the main tutorial text.

Data: This field must be set depending on the tutorial's Type as follows:

For Kill tutorials, the prefab name of the creature that the player must kill. Example: GoblinBrute.
For Item tutorials, the prefab name of the item that needs to enter the player's inventory. Example: QueensJam.
For Location tutorials, the prefab name of the location that the player must get in range of. Example: BogWitch_Camp.