View source for Custom NPC Tutorial

Welcome! In this tutorial we will learn how to use Bonfire's built-in Character Editor in order to create Custom NPCs. First, we'll learn how to design our NPC and place them in the world, then we'll give them basic dialogue and enable them to speak to the player. Afterward, we'll learn how to interact with our NPC by creating branching dialogue and Custom Actions. We'll enable our NPC to "remember" the player, and lastly we'll wrap up the tutorial with a simple fetch quest.

A sample Grem that demonstrates each section is available [https://github.com/shadowlost25/Bonfire-orc-repository/blob/master/NPCs/Mod%20Tutorial%20Orcs/Grem%20-%20Custom%20NPC%20Tutorial%20Sample%20Orc.zip?raw=true here.] Extract them into the "Mods/Characters" folder in your Bonfire AppData directory at:

<code>C:\Users\%username%\AppData\LocalLow\Prasetto\bonfire\Mods\Characters</code>

You can access this same directory by pressing ESC to open Bonfire's main menu, then click "Mods" -> "Open Meta Files Location"

Only activate one version of Grem at a time. Do not save while he is active, or else you will need to use the '''dory''' command to clear out your NPC data.
== Setup ==
Before we begin, it's recommended that you have some familiarity with the [https://hogswilds-bonfire.fandom.com/wiki/Console_Commands Command Console] as we'll be using a couple of them in this tutorial. You don't need to remember everything, but knowing some of the Basic or Debugging commands like '''save''' or '''rel''' will be useful.

The NPC Editor can be accessed from Bonfire's Main Menu. From the title screen, click ''Mods'', then ''Character Editor''.

== Interface Overview ==
[[File:Interface.png|centre|thumb|540x540px]]
# '''File Menu''' - Save your NPC; Load Existing NPCs; Import one of your profiles to use as a Custom NPC; rename the file.
# '''Character Profile''' - Give your NPC a name, and manage their inventory by clicking the '+' icon
# '''Attributes''' - This will apply a default "state" for your NPC when they load in the scene.
# '''Location''' - Sets your NPCs coordinates and the scene (or level) that they will appear in
# '''Metadata''' - Holds data about the Mod creator and a description of the NPC. Please fill this out if you intend to share your NPCs with other players.
# '''Character Dialogue''' - This space holds the entire conversation. To navigate this space, scrolling the mouse wheel will move the view vertically, while holding down the middle mouse button will allow you to pan the view freely.
# '''Navigation''' - "Tiny View" allows you to collapse the entire dialogue tree so it's easier to traverse. The Jump field lets you move to a specific line number.
# '''Exit''' - Exits the character editor and reloads the current scene

== Section 1 - Creating the NPC ==
First, we'll need an Orc to import into the Character Editor. A NPC's appearance is generated by importing one of your pre-existing profiles so we have the option of either creating a brand new profile, or using your own Orc as an NPC. If you choose the later you can skip ahead to Step 2 - Setting your NPC's Spawn Point
# '''Create a brand new profile, or load an existing one'''
#* From Bonfire's Main Menu, click ''Profiles'', then click ''Create New''. Spend as much time as you want designing your NPC's appearance and be sure to give them a name. When you're finished, click ''Enter'' to save your Profile and exit the character creation. Your new Orc will wake up in the Outback.
# '''Set your NPC's spawn point'''
#* Decide where you want your NPC to spawn in the world. Do you want them to show up in the Outback? Occupy the Inn? Lounge at the island? Etc.
#* For this tutorial, we'll spawn our NPC on the Island for ease of testing. Log in to one of your Orcs (or stay with the current one) open the console with the F1 key, and then type:
#** '''travel Sea1'''
#* This will instantly warp you to the Island's entrance. Next, walk around and find a good location to spawn your NPC. Once you've found a good spot, open the console again and type:
#** '''refpos'''
#* '''refpos''' will save your character's current X, Y, and Z coordinates into the console, allowing you to paste them elsewhere.
# I'''mport the character'''
#* We're now ready to create our NPC. Return to the Character Editor by opening the Main Menu (ESC Key), then click ''Mods'' then ''Character Editor''. Alternatively, you can open the console with the F1 key and type:
#** '''chedit'''
#* Near the bottom left corner, click the "Import Character" button and find the Orc you created in Step 1, or import one of your pre-existing characters. You'll see that your Orc's name will appear within the ''Character Profiles'' section. 
# '''Manage your NPC's Inventory'''
#* Expand the ''Items...'' field by clicking the " + " button next to it. This section will let you control your NPC's inventory, including their clothing. By default, new Orcs will only contain a leather Loincloth, but if you imported one of your profiles, you may see all the items you collected in-game.
#* Click "New Item" to add an inventory slot. Click "Change" to select a new item from the list. Click "Remove" to delete inventory slots. Check in "Wear this item" to make your Orc equip this when they spawn.
# '''Set your NPC's attributes''' '''(Optional)'''
#* This section is used to apply a default "state" for your NPC when they load in the scene. For example, you could have them execute a console command, or prevent them from spawning unless the player is at a certain point within Bonfire's story. This isn't necessary for our purposes, so we will skip this part.
# '''Set the location'''
#* This is where we'll use the coordinates we saved in Step 2. In the Scene field, click "World1" and select "Sea1." 
#* In the Position field, select "Paste from Console," and the X, Y and Z fields will populate the coordinates from the '''refpos''' command. For reference, my coordinates are:
#** '''X: '''-27.9501
#** '''Y: '''0.5904999
#** '''Z: '''-41.50909
#* This will place our NPC South-West of the Island's entrance. 
# '''Write the Metadata'''
#* Use the text boxes to sign your name as the author of this NPC, and write a brief description of this NPC. This is recommended if you intend to share your NPC with other players.
# '''Character Dialogue - Hello World '''[[File:Hello World.png|thumb|220x220px]]
#* The right side of the screen holds the "Character Dialogue" section. This is where we'll spend most of our time. It will contain a series of boxes labeled "Line 0, Line 1, Line 2, etc," representing our entire dialogue tree.
#* In the "Speech" section of the dialogue box, type the following message:
#** Hello ''@playername'', my name is ''@playerinterest.'' Congrats on creating your first NPC!
#* Don't worry if you don't know what the rest of the buttons and fields in the dialogue box are for. In the next section we'll go over the functions of a dialogue box and learn how to create basic dialogue.
# '''Save your NPC and exit the Character Editor'''.
#* When you're finished, click the "Save" button, and this will save your NPC as a .bab file located at:
#** ''C:\Users\%userprofile%\AppData\LocalLow\Prasetto\Bonfire\Mods\Characters''
#* Click the "Exit" button. This will immediately reload the game, and place you back at the entrance to the Island.
# '''Enable your NPC'''
#* When the scene reloads, you'll immediately notice that your NPC hasn't spawned in the world yet! That's because they haven't been enabled. To fix this, open Bonfire's Main Menu, then click '''Mods,''' then '''Mod Manager'''. You'll see the list of Mods you have installed currently. Find the name of the NPC you just created, and fill in their circle.Click "Done" and the scene will reload again. Back at the Island's entrance, you should see our newly created NPC. Go speak to them, and they will output the "Hello" dialogue we gave them.

== Section 2 - Basic Dialogue ==
Well done on creating your first NPC! Now that they have a presence in the world, next we'll give them a voice and learn how to create basic dialogue.

Dialogue in Bonfire is made by creating several objects, called "Dialogue Boxes" and linking them together in a series. When you speak to the NPC, they will read the Speech field in first box (usually Line 0) then read the rest of the Dialogue Boxes in the order they appear. 

Dialogue boxes follow a "Parent-Child" relationship. A dialogue box with another box nested under is called the "Parent," while the nested box is the "Child." If the "Child" has other children, then it becomes "Parent" to those children, and so on.   

=== Dialogue Box Colors ===
[[File:Box Colors.png|centre|thumb|440x440px]]
Dialogue Boxes come in three colors, each color represents its purpose within the editor:
* '''Black - Normal Dialogue Box, or "SimpleText" box.''' This is the default type. The conversation will flow from the parent box to the child box until the branch ends. A parent box of the "SimpleText" type is allowed to have multiple children, however, the conversation will only flow to the ''first child ''that was created. Any additional children created will appear as a '''red''' box marking them as "inactive" lines of dialog. This means they won't appear in the conversation normally, and will require additional setup to be reached.
* '''Green - Choices / Conditionals. '''"TextAndChoice" or "Conditional" types change the flow of the conversation, either when the user selects a response from a choice menu, or if a certain condition is met. When done properly, they can be used to create complex quests and conversations. This kind of dialogue box is reliant upon the parents "type" setting to exist. In order to create them, the parent must be of type "TextAndChoice" or "Conditional." Afterward, any new children will be green to represent a dialogue choice, or a Line that will execute under a certain condition. Because the Parent-Child relationship is necessary to create these, '''this means the root of the dialogue tree, Line 0, ''cannot '' be used as a choice or condition.''' 
* '''Red - "Inactive" box. '''This occurs when a "SimpleText" parent has more than one child. The dialogue will flow to the first child naturally and ignore the "inactive" children. In order to reach the "Inactive" blocks, rather than creating a New Line, you can also click the box to "Derive to existing line," and enter the line number you want the conversation to jump to. There's an example of how to pull this off later.
<nowiki/>[[File:SimpleText.png|thumb|270x270px]]

=== Anatomy of the "SimpleText" box ===
* '''Line Number'''
** This is a dialogue box's ID number, but it ''DOES NOT ''represent the order in which the lines are spoken. For example, the typical order of a conversation is "0 > 1 > 2 > 3 > 4 > ..." and so on, but it's possible to re-order the lines of dialogue and have the order as "0 > '''4''' > 1 > 2 > 3 > ..." .
** In addition, when adding or removing dialogue boxes, Bonfire will start from the highest available line number, and continue from there, even if there are gaps in progression. For example, if you start with an order like this:
*** 1 > 2 > 3 > 4 > 5
** But then remove lines 2, 3, and 4, any new lines created will continue from 5 onward:
*** 1 > 5 > 6 > 7 > 8
** While speaking to an NPC, you can keep track of which lines are spoken by using the console command: '''showdiagindex'''. When you speak to your NPC, a number will appear at the beginning of every sentence, representing the line number.

* '''Character Starring'''
** This represents the speaker, and it also defines the default target when any Custom Actions are activated. For example, if there's an action that starts a growth buff, then "Person2" will receive the effect. If there's an action to start sex, then "Person2" will take the top position. Lastly, "Person2" represents the NPC, while "Player" represents the player

* '''Dialogue type'''
** This is set on the Parent to determine the Child box's Type. 
** '''SimpleText''' - Creates a black dialogue box that represents the normal flow of a conversation
** '''TextAndChoice''' - Causes this line to display a text menu, where the player can select subsequent lines as dialogue options.
** '''Conditional''' - A line of dialogue that will only execute when a specific condition is met (ex: Is the player cursed; are they holding a certain item; is the NPC at a certain height range, etc.)
* '''Text Display'''
** This is how the text will appear when the line is spoken
** '''Custom''' - Will print out whatever is written in the "Speech" field as normal.
** '''Generated Orskera''' - Will randomly generate Orcish language, disregarding the text within the "Speech" field
** '''Invisible''' - The text box will not appear at all, and the camera look at the speaker. Useful for applying facial expression or running other actions.
* '''Speech'''
** This is the spoken line of dialogue, if the Text Display is set to "Custom."You can use parameters like ''@playername'' or ''@playerinterest'' in the place of the participants' names.
* '''"Start from here" '''- '''<u>Deprecated as of 0.31</u>'''
** Acts as a marker for where the dialogue will continue if the conversation ended for any reason. However, this field is buggy. Excessive use can cause this NPC's conversation to leak into ''other ''NPCs, overwriting their speech. Furthermore, if you teleport to a different scene, this placeholder is lost, and the player will have to start the conversation from the very beginning.
** '''Note: '''As of version 0.31, this has been deprecated, and will no longer work. In order to make NPCs remember conversations, we now need to use "Data Flags", as will be explained in "Section 5 - Conditionals."
* '''Custom Actions'''
** These are actions that are performed when this line is reached. Custom Actions have numerous uses. They can be used to execute console commands during the conversation, and they can also initiate buffs, start sex, warp the player or NPC to different scenes, etc...
** '''Start Actions''' - These are actions that will activate the moment the speaker opens their mouth.
** '''End actions''' - These are actions that will execute just before the next line, when the player clicks the mouse button to continue the conversation.
* '''Remove'''
** Deletes a full branch of dialogue. If used on a parent with children, all of the children and their children will be deleted along with the parent.
* '''Derive to existing line'''
** Sends control of the conversation to a different line of dialogue that might not be a direct child of the selected box. A common use is to access red dialogue boxes marked as "inactive"
* '''New Followup line'''
** Creates a new child dialogue box. The color and type is dependent on the parent's "Dialogue Type" setting. 
* '''Set'''
** This is used to re-order lines of dialog. When clicked, the current dialogue box '''and all of its descendants''' will move underneath the line specified.
** '''Note''': This field will not appear on Line 0.

=== Dialogue Example ===
Now lets give our NPC a voice. In this example we'll learn how to create a basic conversation. We'll introduce how to use ''@playername'' and ''@playerinterest'' as place holders for each participant's name. Next, we'll play with the order of the dialogue boxes to demonstrate how the conversation flows from one line to the next.

This section and the rest of the tutorial are heavily focused on using line numbers as a guide. As such, it's recommended that you try to follow the tutorial as best as you can and ''only ''create new lines when asked. If you create a new line by mistake, there's a chance Bonfire won't reset the available index numbers. If this happens, it's recommended that you delete the new line first, then save and reload your NPC to continue following the tutorial. This helps ensure that your Line numbers will closely resemble mine.
[[File:BasicDialogue1.png|thumb|270x270px]]
* Line 0
** Clear out the text in the "Speech" field we created in the last section and add the following:
*** ''Hello @playername! Welcome to Part 2 of the Bonfire Dialogue tutorial!''
** Click "New followup line" to create a new child dialogue box.
* Line 1
** Set "Character starring" to "Player''.''"  This will make your character speak this line.
** By default the Type of this dialogue box is "SimpleText" and the Text Display is "Custom"
** Add the following to text to the Speech field:
*** ''Thanks, ''@playerinterest! ''What are we doing this time?''
** Click "New followup line" to create another dialogue box. From this point onward, I'll shorten this step as "New Line."
* Line 2
** By default "Character starring" is always set to "Person2"
** Set the Speech:
*** ''Right now we're trying to get your feet wet in building basic dialogue.''
** New Line
* Line 3
** Keep the "Character Starring" value as "Person2." As you can see, we don't need to alternate between the player and NPC for every line.
** Speech:
*** ''Okay, now we'll end the conversation here.''
Click "Save" to save your NPC, and click "Exit" to reload the scene. Find your NPC and speak to them. You'll see the conversation we just wrote, the camera will flip to show your character once, and the conversation will end at the fourth (''numberOfLines - 1) line.''

Now we'll play with the line order a little. Go back into the character editor and load your NPC to make the following changes. Use the "Jump" or "Tiny view" buttons to quickly navigate to the appropriate lines.
* Line 3
** Replace Speech with:
*** ''This is actually Line 3...''
** New Line
* Line 4
** Speech:
*** ''I've moved this line out of order. This is actually line 4!''
** New Line
* Line 5
** Speech:
*** ''This is line 5. The conversation is back in numerical order from this point on.''
** New Line
* Line 6
** Set "Character Starring" to Player"
** Speech:
*** ''Alright, I'll end this conversation now.''
Don't save just yet. Either scroll up to Line 4, or type "4" in the "Jump to Entry number:" field, and click "Jump." This will move the dialogue interface to Line 4.
[[File:BasicDialogue2.png|thumb|263x263px]]
* Line 4
**In the "Set" field, change the value from 0 to 2, and click "Set." This will move line 4 under line 2 instead of line 3.
However, moving line 4 causes ''both ''line 3 and line 4 to be direct children of line 2. Because line 2 is marked as a "SimpleText" box, the conversation will only flow to the first child created under it, in this case it's line 3. This means any more children created under line 2 will be marked as "inactive." If you were to speak to your NPC again, the conversation would flow as:
*Line 0 > Line 1 > Line 2 > Line 3 > '''end'''. 
Line 4 is unreachable in this state, and thus is never spoken. To remedy this, we'll change the order around once more.
*Line 3
**In the "Set" field, change the value from 0 to 4, and click "Set." Line 3 is now a child of line 4... but wait! Because line 5 was the first child of line 4, line 3 is marked as inactive. We'll fix this once and for all next.

*Line 5
**Change the "Set" value from 0 to 3, and click "Set." Line 5 now becomes a child of line 3. As a bonus, line 6 moved with.
Phew! With that done, the new order of the conversation is:
* Line 0 > 1 > 2 >  '''4''' > '''3 '''> 5 > 6
Save your NPC, exit the editor, and speak to them again. The conversation will follow the new order we created. To check the line numbers while the conversation is in progress, open the command console and use the '''showdiagindex''' command. This will place a number before each sentence to show the line index. 

Next we're going to add an "Inactive" line on purpose, and show you how to access them. Return to the Character Editor and and load our NPC once more. Go to line 0.
[[File:BasicDialogue3.png|thumb|220x220px]]

Line 0
* Click "New followup line"
Scroll all the way down to the bottom, and you'll see the newly created line 7, but it's in an "inactive state." As mentioned before, if we leave it like this, the conversation will never reach line 7 naturally. However, there's a way to access this that doesn't involve re-ordering the conversation. Jump to line 6:

Line 6
* Set "Character Starring" back to "Person 2"
* Speech
** ''Now we'll deal with "inactive" dialogue..."''
* Instead of "New followup line," click "Derive to existing line," and change the value from 0 to 7
Line 7
* Speech
** ''This is LIne 7. It's still in an "inactive" state, but we can reach this line thanks to the "Derive to existing line" box we created.''
* Click "New followup line"
Line 8
* Set "Character starring" to "Player"
* Speech
** ''Nice!''
Save and speak to your NPC. Again, use the '''showdiagindex''' command to show line numbers during the conversation. Notice how, even though Line 7 was "inactive," the conversation still moved on to Line 8. That's because whichever line is given control, the conversation will continue down that branch of dialogue until either it ends, or passes control through choices, conditions, or derives to another line.

This concludes Section 2 of the Custom NPC tutorial. 

== Section 3 - Adding Dialogue Choices ==
Now that we know how to create basic dialogue, it's time to make our conversation branch out a little bit with dialogue choices! These are moments in the conversation where the player is presented with a menu of responses. When a response is selected, the conversation will continue down that branch of dialogue until its conclusion. This enables you to create in-depth conversations with your NPCs with multiple outcomes (see [[Bolt Sunder]]), or create a simple menu for sex. 

To create a Choice Box, simply change the Dialogue Box's "Type" to "TextAndChoice." But wait a second, the box is still black! This is because the TextAndChoice type requires the parent and its children to work together to form a text menu. The parent creates the context, giving the player a question or phrase at which they must respond, while each child serves as one of the responses. 

If you click "New followup line," the newly created dialogue box will be green rather than the usual black. You also might notice that it's type is "SimpleText" rather than "TextAndChoice." This is because the "Type" of the dialogue box really indicates the behavior of its children, and not the box itself. If you were to set this box to "TextAndChoice," this would just make the speaker open a nested menu when the player clicks this response. 

When the parent's line of dialogue is spoken, the game will print out several options as the player's possible responses. Each option represents a child box:
[[File:Response Menu.png|centre|thumb|385x385px]]
=== Anatomy of a Choice Box ===
Choice boxes are nearly identical to the SimpleText box, with a few differences:[[File:Choice Box.png|thumb|220x220px]]
* '''Line Number''' - "Line" now has "(as choice)," placed next to it, indicating this will show up as a response for the parent.
* '''Choice representing this line '''- This is how the response will appear on the menu (See the image above). It's recommended to keep these short and concise. 
* '''Speech''' - This is the actual dialogue that will be spoken, either by the NPC or the Player, ''only ''after this response has been chosen. 

=== Choice Example ===
Open up the NPC we worked on in Section 2, and go to Line 7.

Line 7
* Character Starring is the Player
* Replace the Speech:
** ''Alright, so now that we have basic dialogue and an understanding of how the dialogue is ordered, what else can we do?''
Line 8
* Character Starring is "Person2"
* Replace the Speech:
** ''Now we'll move on to Part 3 of the tutorial: choices.''
* New Line
Line 9
* Change Type to "TextAndChoice"
* Speech:
** ''In sexy times, would you rather be on the giving end or the receiving end?''
* Press "New followup line" '''TWO '''times.
Lines 10 and 11 will both appear as direct children of line 9. You'll notice immediately that even though they're both children of line 9, neither of them have turned red. Green boxes signify dialogue that activates only after a certain condition has been met. In this case, the condition is if the player clicks one of them as a response. Since whether or not they appear is up to the player, they're both considered reachable lines of dialogue. 
[[File:Choices.png|thumb|246x246px]] 

Line 10
* Character Starring is the Player
* Speech:
** ''I'd rather be the one on the "giving" end.''
* In the "Choice representing this line" field, change the text to: "Giving"
* Click "New followup line" to create your NPC's response. 
Since line 10 is the  "SimpleText" Type, the next box will be black instead of green. You'll also notice that this new line starts with 12. Once again, the index for newly created line will always come after the highest available index, which was 11 previously. From this point on, the line ordering will get weird. That's why it's highly recommended you follow the tutorial as closely as possible, to avoid confusion.

Line 12
* Speech:
** ''Then I guess that makes you a top, right?''
* Don't create a new Line. Jump to Line 11.
Line 11
* Character Starring is the Player
* Speech:
** ''I like being on the receiving end!''
* Choice representing this line: ''Receiving''
* New Line
(The newly created line index is 13, since 12 was the previous highest.)

Line 13
* Speech:
** ''Then I guess that makes you a bottom.''
Save and go speak to your NPC. When line Line 9 is reached, two responses will appear under the NPC's speech. These are the dialogue choices we created, representing Line 10 and Line 11. If you click on one of them, your character will say whatever was written to the "Speech" field, and the conversation will continue from that branch.

...What? You were expecting actual sex? Don't worry, we'll get to that and more in the next section.

== Section 4 - Custom Actions ==
Now we'll add a little flair to our conversation using Custom Actions. Actions have a variety of uses. They can be used to initiate sex, fuse with the orc you're conversing with, apply facial expressions, call console commands, and much more!

All dialogue boxes contain fields for "Start Actions" and "End Actions." Start Actions are applied the moment the speaker opens their mouth. End Actions are applied when the player clicks their mouse to start the next line. Dialogue boxes can contain multiple actions.

Check the [[Custom Actions]] page for the list of available actions, and their function.

=== Actions Example ===
First, let's remove some unnecessary dialogue. Jump to Line 1:

Line 1
* Click "Remove"
"Remove" will delete Line 1 and all of its descendants down to Line 6. Be mindful when using this button, as you can potentially delete an entire branch of dialogue unintentionally. If you want to remove a single line within a branch, it's best to re-order the conversation with "Set" to isolate that line '''first''' before removing. 

Since Line 1 is gone, Line 7 can move in to be the first child of Line 0. This causes the box to become black, no longer marking it as "inactive." Now we'll replace the text we created thus far.
[[File:CustomActions - Line 0.png|thumb|272x272px]]

Line 0
* Speech:
** ''Hello ''@playername! ''Welcome to Part 4 of the Bonfire Dialogue tutorial!''
* Press the "+" button next to "0 custom actions" to reveal the Start and End Action fields.
* Start Action:
** Click "New Action" and a new "CustomCall" action is created by default.
** Click the "CustomCall" button to show the list of available actions.
** Find and click "Expression"
*** The Default Expression is "Neutral." Click this, and find "Happy."
*** In the "Sec" field, change the value to 10. 
*** The "Apply to" field can be left blank. The default behavior for Actions is to affect whoever the Starring character is (in this case, it's Person2, our NPC) However, we can change this behavior by writing our target's name, and they will have the facial expression applied to them instead, even if it's an NPC not a part of this conversation!
Line 7
* Replace the Speech:
** ''We've got basic dialogue and choices.... what's next?''
Line 8
* Replace the Speech:
** Now we' ll learn how to create Custom Actions. Do you notice how I'm smiling? Mastering this section will add some personality to your NPCs
* Start Actions
** Expression
*** Happy
*** 10 Secs
Line 9
* Set Type back to "SimpleText"
* Speech:
** ''But enough of that. Let's do something a bit more... practical.''
* Start Actions
** Expression
*** Pleased
*** 10 Secs
Line 10 and Line 11
* Remove both of these lines, and add a new line under Line 9.
Line 14
* Set Type to "TextAndChoice"
* Speech:
** ''What do you want to do?''
* Click "New followup line" '''SIX''' times.
Lines 15 - 20
* In each new we created, set "Character Starring" to "Player."
Line 15
* Choice representing this line: ''Console Command''
* Speech:
** ''Let's try out a console command.''
* New Line
[[File:CustomActions - Line 21.png|thumb|220x220px]]

Line 21 
* Speech:
** ''Alright, so the command we're using is the '''"dwarve"''' command. This will change your target into a dwarf, like so!''
* End Actions
** Leave "CustomCall" the default
** In the "String Parameter" field, enter the following:
*** '''dwarve '''''@playerinterest,100,2,0''
* New Line
Line 22
* Speech:
** ''Next, I'll show you the "'''origins'''" command. This will change your target back to whatever form they had at the moment of creation.''
* New Line
Line 23
* Speech
** Annnd done!
* Start Actions
** '''batch target '''''@playerinterest''';'''''<nowiki/>'''origins;targetclear'''
In Line 23's CustomCall we just added three console commands. First, the '''batch''' command allows us to string multiple commands in a single line, separated by a semicolon(;). We then target the NPC in front of us with '''target '''''@playerinterest.'' Next, we restore our NPC's form with the '''origins''' command, and finally we return control of the console back to the player with '''targetclear.'''

All of this was added on one line thanks to the '''batch''' command, but it's perfectly legal to have multiple CustomCall actions within the same dialogue box. The command will run in the order they're created.

==== '''A Warning on Console Commands''' ====
<blockquote>It's important to keep in mind that sometimes players will have more mods activated than just yours. Therefore it's especially important that any time you use console commands in dialogue, you ''must'' end every call with the '''targetclear''' command. This will reset the current target of the console back to the player and helps minimize conflict between other mod creators' NPCs, who might also use console commands for some other task.</blockquote>We're done with this branch. Save your NPC and go speak to them again. Select the Console Command option, and your NPC will run the command we just gave them. The other options don't do anything except make you speak a generic line, as we hadn't created those responses yet.

Next, let's turn the menu into a loop, so whenever you pick an option, the dialogue will come back to the menu, without having to view the introductory text every time. Open our NPC and jump to Line 23:

Line 23
* Click "Derive to Existing Line" and set the value to 14.
Now when you select this option again, the dialogue will return to line 14, and your NPC will ask you to select the next response. Let's create an exit out of the conversation so you wont be stuck in an infinite loop. Jump to Line 20

Line 20
* Choice representing this line: ''Leave''
* Speech
** ''That's enough for now, I'll see you later, ''@playerinterest
* New Line
Line 24
* Speech
** ''Alright see you.''
You can test this if you want, but now let's go create the rest of the choices. Jump to Line 16.

Line 16
* Choice representing this line: ''Sex''
* Speech
** ''Let's bang!''
* New Line
Line 25
* Set Type to "Text and Choice"
** (You can nest menus within menus)
* Speech
** ''Heh, I was wondering when you were going to pick that. So, do you feel like topping or..?''
* Click "New followup line" '''TWO''' times. This will create two choices.
[[File:CustomActions - Line 26.png|thumb|220x220px]]

Line 26
* Character Starring is the Player
* Choice representing this line: ''Top''
* Speech
** ''I'll top this time. Turn around.''
* End Actions
** Click "CustomCall" and find "QuickInteraction." These are the list of available sex positions.
*** Leave the interaction type as "SexAnal1." This is Doggy style.
*** Leave "Swap Role" blank. We'll use that next.
* New Line
Line 28
* Speech
** ''Oof... that was awesome!''
* Derive to Existing Line: 14
* '''NOTE''': '''When we test this, it's not going to work as expected. More on that later...'''
Line 27
* Character Starring is the Player
* Choice representing this line: ''Bottom''
* Speech
** ''I wouldn't mind getting pounded...''
* End Actions
** QuickInteraction
*** Set Interaction Type to "SexAnal2." This is the Missionary style.
*** Click "Swap Role." By default, whichever participant is selected in the "Character Starring" field will take the top's position. This will reverse that behavior, and make them bottom instead.
* New Line
Line 29
* Speech
** ''How'd that feel?''
* Derive to existing line: 14
* '''NOTE: again, this won't work as expected.'''
Save your NPC and test the new "Sex" option. You'll immediately notice that after either of you cum, the post-sex dialogue we implemented will not play, and you won't be sent back to the dialogue menu. Instead, the game's vanilla dialogue appears and the conversation ends.

Try this: Choose the Sex option again, and press the ESC key to cancel the animation early. Now our post-sex dialogue will play like it's supposed to. Why did this happen? That's because dialogue works slightly differently when sex is involved. Don't worry about this for now. A section on how to implement Post-Sex dialogue has been included in Section 7. 

For now let's return to the editor. To free up some space, go Line 15 and 16 and press the "-" symbol in the top right corner. This will collapse those branches of dialogue, making it easier to stay organized.

Line 17
* Choice representing this line: ''Buff''
* Speech
** ''How about a Buff?''
* New Line
Line 30
* Speech
** ''Alright... one buff, coming right up!''
* End Actions
** Add one CustomBuff
*** Click "Sweat" and set Buff type to "HeightIncrease"
*** Set "Sec" to 30
*** Set "Repeats" to 15
** Add another CustomBuff
*** Set Buff type to "HeightIncrease"
*** Set "Sec" to 30
*** Set "Repeats" to 5
*** Check in the option to "Apply to other character"
* New Line
In Line 30 we changed the Sec and Repeats fields to modify the strength and duration of the buff, respectively. "Sec" is the buff's duration, and can be any value between 0 and 1E+08 (100,000,000) seconds. "Repeats" refers to how many units are added to that specific attribute while the buff is active. This can be any number between 1 and the attribute's max value (usually 100). For example, if the Repeats amount is 100, that attribute will instantly max out when the buff activates. If Repeats is 1, that attribute will fill out slowly.

The "Apply to other character" fields works the same way as the QuickInteraction Action. By default, buffs will only affect whomever is selected in the Character Starring field. If you check this in, you'll affect the other participant in the conversation instead.

Line 31
* Speech
** ''And here we go! I applied a HeightIncrease buff to both of us. If neither of us are at the max height already, I should be growing rather quickly, while you should grow at a snail's pace.''
* New Line
Line 32
* Character Starring is the Player
* '''Text display is "Invisible" '''- This will cause the camera to show your character, but without text.
* Speech can be left alone since it's invisible.
* New Line
Line 33
* Speech
** ''Alright, that's enough for now. I've stopped the buffs and turned us back to normal.''
* Start Actions
** RemoveAllBuffs
** Add Another RemoveAllBuffs
*** Apply to other character
** CustomCall
*** '''batch target '''''@playerinterest;origins''
** Add another CustomCall
*** '''batch targetclear;origins'''
* Derive to Existing Line: 14
Save and test our buff. In case you or your NPC are already at the max height, open the console and use the '''lordofshapes''' command to open a compact character editor. From here you can adjust your heights so you can view the buff's effect. 

Return to the editor and jump to Line 18

Line 18
* Choice representing this line: ''Fuse''
* Speech
** ''Let's try fusing?''
* New Line
Line 34
* Speech
** ''Okay, but first there are two ways to break up fusions. Along side the "Fuse" action, there's also an "Unfuse" action to split us up again. Alternatively, if you open your inventory, you'll see the essence of all of your fusion partners. Right-Click any of them to take them out of the fusion.''
* New Line
Line 35
* Speech
** ''Now then...''
* New Line
Line 36
* Character Starring is the Player
* Speech
** ''Ahhh, there we go!''
* Start Actions
** <s>Fuse</s> (This is currently buggy as of 0.31.0. Until it gets fixed, use the CustomCall below instead) 
** CustomCall
*** '''fusenew'''
* New Line
Line 37
* Character Starring is the Player
* Type is "TextAndChoice"
* Speech
** ''The fusion is complete. Do you want to unfuse now, or stay like this?''
* Click "New followup line" '''TWO''' times
Lines 38
* Character Starring is the Player
* Choice representing this line: ''Unfuse''
* Speech
** ''I think that's enough for now...''
* New Line
Line 40
* Speech
** ''And there you have it.''
* Start Actions
** <s>UnFuse</s> (This is currently buggy as of 0.31.0. Until it gets fixed, use the CustomCall below instead)
** CustomCall
*** '''unfuse'''
* Derive to Existing Line: 14
Line 39
* Choice representing this line: ''Stay fused''
* Speech
** ''I think I'll stay like this a little longer...''
Save your NPC and test the fusion.

'''Note''': The Fuse and UnFuse actions are special. They ''must'' be created as Start Actions only. If you try to set them as an End Action, Bonfire will re-assign them to Start actions when the NPC is saved.

'''Note II:''' As of 0.31.0 the Fuse and UnFuse actions aren't working properly. When the actions execute, they will skip over the Speech field, and they will skip over the next line that follows. Also, if the next line is of type TextAndChoice, the game will soft lock, forcing the player to reload the scene. For now, we're substituting those actions with the '''fusenew''' and '''unfuse''' commands.

Return to the editor and jump to Line 19

Line 19
* Choice representing this line: ''Teleport''
* Speech
** ''What is teleporting?''
* New Line
Line 41
* Speech
** ''Exactly what it sounds like! When the action activates, either you or I will teleport to the coordinates specified.''
* New Line
Line 42
* Speech
** ''Tell you what: I'm going to teleport somewhere on this island. See if you can find me!''
* New Line
[[File:CustomActions - Line 43.png|thumb|276x276px]]

Line 43
* Speech
** ''And here I go!''
* Start Actions
** TeleportToCoordinate
*** By default the character will teleport to the world's "Origin" point, which is (0,0,0). But we're going to change this so our NPC teleports to the nearby island. 
*** First, save our NPC but don't speak to them yet. Walk over to the island where you found the Genie's Bracers. Open the console with F1 and enter the '''refpos''' command. This will copy your coordinates to the clipboard. Open your NPC in the Editor again and jump to line 43.
*** Click "Paste" and you'll see the coordnates we obtained from '''refpos'''. For reference, the coordinates I'm using are:
**** '''X''' = 77, '''Y''' = 10, '''Z''' = -115
Save, then speak to your NPC to test the Teleport action.

This concludes Section 4's lesson on Custom Actions. Custom Actions are an essential tool to add interest and personality to your NPCs, and we've only scratched the surface on their applications. They're vital, especially when it comes to writing [[Macros|Macros.]] In this tutorial, I tried to go over some of the most essential Custom Actions, but there's so many that going over all of them is beyond the scope of this tutorial. It's a good idea to experiment with some of the Custom Actions when you write NPCs on your own.  

In the next few sections we'll go over some more advanced concepts, and introduce conditional flags to our NPC. 

== Section 5 - Conditionals ==
With the previous four concepts, you technically have enough knowledge to create fully functioning NPCs on your own. However, we can expand our knowledge and give our NPCs an extra layer of complexity by learning how to create Conditionals.

There are several uses for Conditionals. You can have an NPC check for the player's dick size and make them deny sex if the player's dick is too big. You can implement a fetch quest where the NPC asks the player to gather a certain number of items. You can even implement special Data Flags that enable the NPC to remember the player, and start new conversations based on their previous encounters. Conditionals are a powerful tool that, when used appropriately, allow you to create NPCs with their own storyline.

To set a Condition, we need to use Conditional Boxes. These are a special type of Dialogue Box that allow us to set one or more rules to check for. If the rules are met, the Conditional Box will execute and the conversation will continue down that branch of dialogue. If the rules aren't met, the Conditional Box is skipped over. Think of this as the [https://www.computerhope.com/jargon/i/ifstatme.htm If Statement] in programming.

Our lesson in Conditionals will actually span two sections. In this section, we'll learn how to implement Data Flags to skip our NPC's introductory text whenever we speak to them. Then in Section 6, we'll combine Data Flags and regular Conditions to implement a simple fetch quest.

=== Anatomy of a Conditional Box ===
A Conditional Box is created by setting the "Type" of its Parent to "Conditional"

It is visually similar to the "TextAndChoice" Box, however the "Choice representing this line" field has been replaced by "Execution Conditions." A list of possible conditions is available [[Execution Conditions|here]].

A Parent can have multiple Conditional Boxes as Children, but only one of them will execute if their Conditions are met.
[[File:Conditional - Anatomy.png|thumb|234x234px]]

* '''Execution Conditions '''
** This Dialogue will execute ONLY if the below condition(s) are met, otherwise it is skipped.
** ''New Condition - ''Adds a rule the box will check for. This is set to an "IfItemFlag" condition by default.
** If there are no conditions specified, then this Dialogue Box will run as normal

=== Explanation of Data Flags ===
Data Flags are special items created during the conversation. They can hold a single, numerical value, like a [https://whatis.techtarget.com/definition/variable variable] and are stored within the target's inventory (either the player, the person they're speaking to, or a completely different Orc, if named in the target field).

Data Flags are controlled using the "SetFlag" Custom Action. This action allows you to set the flag's name and value, and give it to a target. If the target doesn't have this Data Flag already, a new one is created with the desired name.

Data Flags are checked with the "IfItemFlag" Execution Condition. It works similarly to "SetFlag," except you can now use [https://hogswilds-bonfire.fandom.com/wiki/Console_Commands#Special_arguments.2FLogic Special Arguments] like "greater than" (@>> ''number'') or "less than" (@<< ''number'') to compare the flag's value. 

Data Flags are useful as you can make your NPCs remember the player and their quest progress. We'll try this out with our NPC by making them skip their introductory text, and instead show their menu right away.

=== Conditionals Example ===
First, we're going to re-arrange our dialogue to support Data Flags. Open our NPC in the Editor, and jump to Line 7.

Line 7
* Click "New followup line" and create Line 44.
Line 44
* We're going to make this the new "entry point" of our NPC's greeting text.
* Speech:
** ''Hello @playername! Welcome to Part 5 of the Bonfire Dialogue Tutorial!''
Back to Line 7
* In the "Set" field, change the value to '''44''' and click "Set." This will push the entire dialogue tree we've done at this point under line 44.
When creating a Data Flag to act as the NPC's memory, we'll want to do some preliminary checks before we start the actual conversation. First, we'll need to check if the player has the NPC's Data Flag within their inventory already. If not, we need to give it to the player, and start the conversation as normal. If the Data Flag already exists, then we can start appropriate conversation based on the Flag's value. 

To that end, we'll need to convert Line 0 so it gets skipped over, and use its next two children to create and check the Data Flag.

Line 0
* Set "Type" to "Conditional"
* Speech
** ''Root of the dialogue tree.''
* Start Actions
** Change the "Expression" action to "QuickSkip"
** QuickSkip
*** When this line of dialogue is reached, the game will skip it and play the next line in the converstaion instead. Since the Speech field will not play at all, we've re-purposed it to make a note of our conversation's logic.
* Click "New followup line" '''TWO''' times.
[[File:Conditional - 45.png|thumb|351x351px]]

Line 45
* Speech
** ''Does the player have the Data Flag?''
* Execution Conditions
** Click "New condition" and by default it will be set to "IfItemFlag."
** IfItemFlag
*** Flag ID Name: '''myNPC_flg'''
*** Flag conent: '''@any'''
*** ...or instead check on: '''@playername'''
* Start Actions
** QuickSkip
* New Line
So in this Condition we're checking two things. First, we want to see if the player has a Data Flag called "'''myNPC_flg'''" stored in their inventory somewhere. Next, we want to check if the Data Flag's content is matching a specific value. At this stage we just want to make sure the player has this Data Flag at all, so we don't care about the actual value yet. For now the content field is occupied by ''@any'', which means the value can be anything. We will check for specific values later in this example.

Also, just as with Line 0 we added a "QuickSkip" action so no character actually speaks this line. We've re-purposed the Speech field as a comment on the conversation's logic. 

Now lets jump to Line 46 (not the newly created Line 47)
[[File:Conditional - 46.png|thumb|347x347px]]

Line 46
* Speech
** ''The player doesn't have the Data Flag. Give them a new one and start the conversation.''
* Execution Condition
** Leave this blank. Do not add any extra conditions.
* Start Actions
** SetFlag
*** Flag ID Name: '''myNPC_flg'''
*** Flag content: '''0'''
*** ...or instead apply to: '''@playername'''
** QuickSkip
* Derive to Existing Line
** Leave this at 0. 
In Line 46 we omitted the Execution Condition. What this means that, if Line 45's Condition evaluates to "False" (Does the player have '''myNPC_flg''' already?) then this Condition will execute instead. There's a benefit to having a blank Execution Condition. If you have multiple Condition Boxes, each checking a different Condition, you would want to have a default path of execution in case everything fails. This will prevent the conversation from ending prematurely, and enables you to run additional tasks. In programming, think of a blank Condition as the "else" clause in an "If" statement.

Okay, so now we've made sure the player receives the NPC's data flag, but there are a few more things we need to do before we're ready to test. Jump to Line 47

Line 47
* Set Type to "Conditional"
* Speech:
** ''Padding. The next layer contains every conversation.''
* Start Actions
** ''QuickSkip''
* Press "New followup line" '''TWO '''times.
Line 48
* Speech:
** ''First Encounter''
* Execution Conditions
** IfItemFlag
*** Flag ID name: '''myNPC_flg'''
*** Flag Content: '''0'''
*** ...or instead check on: '''@playername'''
* Start Actions
** QuickSkip
* Don't create a new line. We'll re-order the boxes again.
Line 49
* Speech:
** ''Second Encounter''
* Execution Conditions
** IfItemFlag
*** Flag ID name: '''myNPC_flg'''
*** Flag Content: '''1'''
*** ...or instead check on: '''@playername'''
* Start Actions
** QuickSkip
* Again, don't create a new line.
So in Line 48 and 49 we have a check for '''myNPC_flg'''<nowiki/>'s value, similar to Line 45. However, this time we have a specific value to check for. When we created the Data Flag in Line 46, we gave it an initial value of '''0'''. So now when the player speaks to our NPC, the box we called the "First Encounter" will play because it's also looking for an Data Flag called '''myNPC_flg '''with a value of '''0'''. So now let's turn Line 48 into an actual branch of dialogue. Jump to line 44.

Line 44
* In the "Set" field, change the value to '''48''' and click "Set." All of the dialogue at this point will move to Line 48. 
Save and speak to your NPC. If everything was done correctly, you shouldn't notice anything different. Your NPC will speak to you and present the choice menu as normal. However, there will be a subtle change. Open the console with the F1 key and enter the '''showhiddenitems''' command, and open your inventory with the 'I' key. This will show you all the hidden fields and values Bonfire uses to manage its characters. Scroll to the bottom of your inventory, and you should see a blue icon with a giant "S." If you hover over this you'll see:
[[File:Conditional - ItemFlag.png|thumb|220x220px]]
<blockquote>ITEM FLAG</blockquote><blockquote>NAME: MYNPC_FLG</blockquote><blockquote>DATA: 0</blockquote>Our NPC gave us the Data Flag we created earlier! Now that we know this works, we can tweak our conversation a little more. Go back into the NPC Editior, and jump to Line 14.

Line 14
* Change Speech to:
** ''Welcome back @playername, What do you want to do?''
* In the "Set" field, change the value to '''49''' and click "Set." All the choices we created will move under line '''49'''.
Jump to Line 8
* Change Speech to:
** ''Now we'll learn about Conditionals. If you followed the tutorial up to this point, you would have found a Data Flag called "'''myNPC_flg'''" within your inventory.''
Line 9
* Change Speech to:
** ''Right now it's set to 0. I'm going to set it to 1, and this will make me skip this introduction every time we speak. I'll end the converssation here, but talk to me again when you're ready.''
* Start Action
** Keep the Expression. Or remove it. Whichever you prefer.
* End Action
** SetFlag
*** Flag ID name: '''myNPC_flg'''
*** Flag content: '''1'''
*** ...or instead apply to: '''@playername'''
Save your NPC and speak to them. After the first conversation ends, speak to them ''again'' and instead of the introduction, you'll be presented with the dialogue options right away. Every time you speak with your NPC, you'll always be presented with this dialogue option.

Next, open the console with F1 and enter the '''save''' command to save your progress at this point. Close Bonfire, re-open it, and come back to speak to your NPC. Instead of the usual greeting, they'll jump right to the dialogue options.

With this, you've created an NPC that remembers you! By setting up Data Flags, you're giving NPCs a point of reference to start up different conversations. This enables you to create multi-part quest lines with different objectives, as well as an "end state" where the NPC will remember everything that was done previously.

It's possible to clear the NPC's memory and start over, however. If you use the '''dory''' command, or speak to [[Kult]], they will clear our all Data Flags and other NPC information from your inventory. This isn't recommended on your main Orc, because it essentially resets your quest progress for the whole game. Use it wisely.

== Section 6 - Fetch Quest Example ==
With Data Flags we created our NPC's memory. Now let's try another type of Conditional to make a simple fetch quest. We're going to make our NPC give the player a task to search for coconuts around the island. We'll need to create a new dialogue choice within our NPC's menu to support this, but we also want our NPC to remember that they've sent us on a quest in the first place. This means we'll need to create another Data Flag to track the state of this quest. Go back into the NPC editor and load our NPC. Jump to Line 14:

Line 14
* Click "New followup line"
Line 50
* Speech
** ''Start a Quest''
* Choice representing this line: ''Quest''
* Start Actions:
** QuickSkip
* New Line
Line 51
* Type: "Conditional"
* Speech
** ''Padding''
* Start Actions
** QuickSkip
* Click "New followup line" '''THREE''' times.
Line 52
* Character Starring: "Player"
* Speech:
** ''Do you have a quest?''
* Execution conditions
** Leave this blank.
* New Line
Line 55
* Speech
** ''Ah, I was wondering when we'd get to this part!''
* Start Actions
** Expression
*** Pleased
*** 10 Sec
Line 56
* Speech
** ''Yes, I'm feeling a bit hungry. Can you look around the island and bring back some Coconuts? I think about 10 would do.''
* New Line
Line 57
* Character Starring: "Player"
* Speech
** ''Alright, 10 Coconuts. I'll be back soon.''
* New Line
[[File:Quest - 58.png|thumb|264x264px]]

Line 58
* Speech
** ''Thanks! I'll wait here.''
* End Action
** SetFlag
*** Flag ID name: '''myNPCQuest_flg'''
*** Flag content: '''0'''
*** ...or instead apply to: '''@playername'''
In this branch of dialogue we created a brand new Data Flag, "'''myNPCQuest_flg'''," completely separate from "'''myNPC_flg.'''" This additional flag will let our NPC remember that the player is currently doing a quest for them, otherwise the same introductory text would play when we choose the "Quest" option. 

Now jump to Line 52:

Line 52:
* Click the "-" button in the top right to minimize this branch of dialogue. We're finished with this one for now.
Line 53
* Type: "Conditional"
* Speech
** ''So how'd it go? Did you find 10 Coconuts?''
* Execution Conditions
** IfItemFlag
*** Flag ID name: '''myNPCQuest_flg'''
*** Flag content: '''0'''
*** ...or instead apply to: '''@playername'''
* Click "New followup line" '''TWO''' times
[[File:Quest - 59.png|thumb|249x249px]]

Line 59
* Character Starring: "Player"
* Speech:
** ''Here you go! 10 Coconuts, like you asked.''
* Execution Conditoins
** Click "Change" and find "IfHasConsummable"
*** Click "...Stiff Fruits?" and change to "Coconut"
*** Required number of items: '''10'''
*** ...or instead check on: '''@playername''' (optional, since the target is already the Player)
* New Line
"IfHasConsummable" is a different condition than the "IfItemFlag"s we created up to this point. This time Bonfire is checking for an item that already exists within the game, and uses a numerical value to check for the quantity the target holds. Each Condition type has it's own method for checking values. For example, the "IfAboveHeight" and "IfCorruptionIs" conditions use a mix of sliders and [https://hogswilds-bonfire.fandom.com/wiki/Console_Commands#Special_arguments.2FLogic comparison operators] in order to execute when the attribute falls within a certain range; while conditions like "IsTalking" or "IsBusy" do not require additional input. Spend some time looking through each [[Condition]] to get a feel for their purpose.

Line 61
* Speech
** ''Ooh, these look yummy!''
* Start Actions
** Expressions
*** Pleased
*** 10 Sec
* New Line
Line 62
* Speech
** ''Excellent! You now have a grasp on the basics of quest creation.''
* New Line
Line 63
* Speech
** ''So how about we celebrate by eating these Coconuts together? Click the Quest option again, and we'll chow down!''
* End Actions
** SetFlag
*** Flag ID name: '''myNPCQuest_flg'''
*** Flag content: '''1'''
*** ...or instead apply to: '''@playername'''
Jump to Line 59
* Press "-" to minimize this branch as we're done with it.
[[File:Quest - 60.png|thumb|220x220px]]

Line 60
* Character Starring: "Player"
* Speech
** ''Sorry, not yet. I'm still looking around.''
* Execution Conditions
** Leave this blank. Since Line 59 executes if the player has at least 10 coconuts, Line 60 will execute if the player has anything less than 10.
* New Line
Line 64
* Speech
** ''Alright, take your time. I'll just sit here and starve.''
* Start Actions
** Expression
*** Happy
*** 10 Sec
* New Line
Line 65
* Character Starring: "Player"
* Speech
** ''...''
* Start Actions
** Expression
*** Angry
*** 10 Sec
Now we have "Quest in Progress" dialogue. After sending you on your quest to collect the coconuts, your NPC will present you with a new conversation that changes depending on the number of coconuts you have. Once you find all 10, the quest will end. 

Now let's work on the Post-Quest dialogue, and have you both eat the coconuts! Jump to Line 53.

Line 53
* Click the "-" at the top right corner. We're done with this branch now.
Line 54
* Speech
** ''Thanks again for the Coconuts, @playername! As thanks, I'll share some with you!''
* Execution Conditions
** IfItemFlag
*** Flag ID name: '''myNPCQuest_flg'''
*** Flag content: '''1'''
*** ...or instead apply to: '''@playername'''
* Start Actions
** Expression
*** Happy 
*** 10 Sec
* New Line
Line 66
* Speech
** ''Bon appétit!''
* Start Actions
** Expression
*** NomNom
*** 10 Sec
** CustomBuff
*** BodyFatIncrease
**** 1 Sec
**** 10 Repeat
* New Line
Line 67
* Character Starring: "Player"
* Speech
** ''You and @playerinterest each eat a coconut''
* Start Actions
** Expression
*** NomNom
*** 10 Sec
** CustomBuff
*** BodyFatIncrease
**** 1 Sec
**** 10 Repeat
Save your NPC, exit the editor, and speak to them. Select the "Quest" option to start the quest we created. After the quest is completes, you and your NPC will eat the Coconuts together, gaining 10 units of BodyFat each time you select the option.

This ends the Fetch Quest Example. 

== Section 7 - Post-Sex Dialogue ==
And now, for our final lesson, we're going to tweak our NPC's Sex option a little bit.

Back in the Custom Actions section we added a choice to initiate sex with our NPC, and the end we tried to add post-sex dialogue that would take the player back to their NPC's menu. When we tested this, however, our dialogue was overridden with the game's vanilla text, ''unless'' we cancelled the animation early with the ESC key. 

Why did this happen? That's because the dialogue system works slightly differently after sex. For example, when you fail to fuse with one of the Lore NPC's like Celik or Bo, they'll react differently if you don't cum at the same time. Likewise if you fail to cum in sync with a Fantasy Orc or a Custom NPC, the vanilla dialogue will take notice as well.

How can we control this behavior? It's actually very easy: We just need to create five lines of dialogue under the Box whenever we call the "QuickInteraction" action.

Open the NPC editor again and jump to Line 26, where the player offers to top. We need to work on the Line below it: Line 28.
[[File:Post-Sex.png|thumb|259x259px]]

Line 28
* We're going to rebuild our dialogue, so for now, remove line 28.
Line 26
* Click "New followup line" '''FIVE''' times.
* You'll notice we we'll have 4 Red, "Inactive" lines of dialogue. '''This is fine. DO NOT change line 26's type!'''
Line 68
* Speech
** ''Quit Sex''
Line 69
* Speech
** ''OrcA came''
Line 70
* Speech
** ''OrcB came''
Line 71
* Speech
** ''Both came / Fusion''
Line 72
* Speech
** ''Either came late''
After sex ends, the conversation will jump to one of these five branches depending on the outcome:
* If you press the ESC key and quit sex early, Line 68, "Quit Sex" will play.
* If only the NPC cums, Line 69 "Orc A came" plays.
* If only the Player cums, Line 70 "Orc B came" play.
* If synchronous orgasm is achieved, Line 71 "Both came / Fusion" will play (this is where you would add a Fuse action or Console Command to fuse both participants.)
* And lastly, if either of you cum late, Line 72, "Either came late" will play out.
Save your NPC and test out all of the outcomes. Your NPC will now respond to sex similarly to a Lore NPC. Feel free to modify the post-sex dialogue and continue the conversation how you want. 

Also, in this tutorial, we only added the dialogue for when the player decides to top. If the player decides to bottom, the game will default back to the vanilla text because we haven't set up the dialogue for bottoming yet. We will need to do this after every call to Quick Interaction, but there is a way to lighten your workload a bit.

Open your NPC again, and jump to Line 27, where the player decides to bottom.

Line 27
* Click "New followup line" '''FOUR '''times.
Lines 73 to 76
* Start Action
** QuickSkip
* Derive to existing line: 29
Save your NPC and speak to them. Select the action to "Bottom." Regardless of the outcome, the conversation will jump to Line 29 ("How'd that feel?") before jumping back to the NPCs menu. This saves you time from having to write unique dialogue for every outcome. 

== Tips for Custom NPCS ==
* Use a text editor to write an outline of your script, and the desired actions ''first'' before you begin development. Seriously, this can save so much time.
* When you finish with your NPC, share them at Bonfire's [https://discord.com/invite/Krhbrs8 Discord Channel] so the rest of the community can play it!
* Download and play other NPCs for ideas. Orcs created by the community can be directly summoned in the game's '''NPC Manager''' under the '''Sandbox''' options menu entry: normally shows NPCs already existing in your computer until you hit the '''Refresh''' button, which downloads a list of NPCs stored in the online community database.
* Each player has a unique approach to the character they roll in game. In order to help them stay in character, try to provide your NPC with multiple dialogue branches of varying attitude.
* Avoid creating NPCs that force the player into unexpected or unwanted situations that go against their character and will, such as forced sudden sex, fusions, transformations and so on. Keeping these under "choices" is a good approach for this kind of action.
* Be mindful when using the "save" command on your NPC, specially after they force the player character into situations that change their character or the environment around them; such use would make those changes permanent even if they may not like them, making it impossible for them to restore a previous state.
* In order to be in line with core game dialogues, keep character speech inside quotation marks, and viceversa for narrator or descriptive text. Avoid using asterisks.
* When creating Data Flags, ''always'' add your NPC's name as a prefix. For example, if your NPC is supposed to play a one-off reaction to getting corrupted, you might track this reaction with a data flag called: '''MyNPC-'''ReactToCurse, or '''MyNPC-'''ReactToCure.
** In old Grem's case, he would use: '''Grem-'''ReactToCurse or '''Grem'''-ReactToCure.
**Following this naming convention reduces the likelihood that multiple NPCs in the same scene will try to access and manipulate the same data flag, which could result in quests breaking.
[[Category:Tutorials]]