Here's a simple to understand, but in-depth guide for how to make your NPCs using my framework. If you need any help, you can join my Discord server[discord.com] because it'd be much better to have a conversation there.

I ask that you subscribe to this Discussion so you don't miss out on updates. This will rarely be updated, if at all, because all of this is supposed to be future proof. However, we wouldn't want your mod(s) breaking due to an update would we?

You must declare a table variable that will contain all of the information regarding your NPC.
If you want to go fancy, you can even make a table of tables containing all your NPCs, or just declare various individual tables instead. Up to you.
Example: MyNPCData = { }

"Global Mod Data" refers to data (Variables) that are saved in files and persist even when you leave the game. They are exclusive to each save, so you don't need to worry about a Player having multiple saves.

There is only ONE variable you MUST pay attention to here. YourVariable.FirstStart.
This is a boolean variable that determines whether this is the first time your NPC is being generated or not. It must be TRUE by default.

It is very easy to make it so your NPC data is saved. Simply make a local function that listens to when global mod data is loaded, and create / load it properly, like so:

Now that you have all the variables ready for use, let us get to the real action.
Whenever you wish to generate an NPC (Most likely on game start), define a local table variable that will contain the properties you wish your NPC to have.

You can check a list of all the properties here, or simply read the framework code in the file BB_NPCFramework.lua.

Here's an example of a very basic properties table:

After declaring the variable, you must actually generate the NPC itself using these properties. To do that, simply call BB_NPCFramework.CreateNPC(), like so:
Example: MyNPCData.npc = BB_NPCFramework.CreateNPC(MyNPCData, npc_parameters)

Your NPC is now ready for usage! However, they are naked and have no real functionality.
If you want to write your very own custom behavior from the ground up, your guide ends here.
Otherwise, if you want to keep using the framework's functionality, read on.

With your NPC generated, it is time to modify it to wear exactly what you want, and do whatever you tell it to do. Let's begin with giving it items.

To setup your character, call the function BB_NPCFramework.SetupNPC()
This function will handle loading your NPC's equipment and inventory. It will return a string "OK". If this is the first time the NPC is being generated,it will instead return a string "CUSTOMIZE".

If you want your NPC to have starting out equipment and inventory, check if the function returns "CUSTOMIZE", and then assign items to it. Here's an example:

If you want your NPC to also immediately start using all the modules provided by this mode, you can call BB_NPCFramework.SubscribeNPCToAllModules() instead of SetupNPC.

The framework contains various separate modules that can automatically handle NPC behavior for you. You can subscribe your NPC to these modules easily by calling ModuleName.ManageNPC(). Alternatively, you can simply call BB_NPCFramework.SubscribeNPCToAllModules(), as mentioned earlier, to subscribe to ALL modules at once.

You can check a list of all the modules here[http//AAAAAAAA], or simply read the framework code in each file of the framework.

I highly recommend, and INSIST you subscribe to at least the Save, or MyLittleSave module.
This one is responsible for handling storing your NPC's persistent data, and is fully compatible with the Setup function by default.

Here's an example of subscribing to save, movement, combat, name tag and speech:

You can subscribe and unsubscribe from any module easily by utilizing the ModuleName.ManageNPC() or ModuleName.RemoveNPC() functions.

You MUST handle and unsubscribe from ALL modules your NPC is subscribed to when they die, or errors will occur. This can easily be done by calling BB_NPCFramework.UnsubscribeNPCFromAllModules() when the NPC dies. You can also unsubscribe individually.

Here's an example of unsubscribing from the individual modules we subscribed to earlier:

That's it! It's THAT easy! Hope you enjoyed the guide, and have fun with your amazing, custom NPCs!

Join my Discord server[discord.gg] now! I'm more active there and will gladly help you with any issues you might have.