This mod have high priority and should load before any other mods that uses its features so isn't necesary to include it in your metadata file. The main features of this mod includes displaying the name of the entity, a custom title if it haves one and in the case of monsters, it displays if they are of a rare breed(Albino Poptop, Fire Gleap, etc) and elite.

There are two displayers, name displayer and title displayer which will automatically show depending on the configuration of the entity which i will describe in the sections below.

Also, when i mention that something is harmless, that means that your mod will function normally even if "Book of Spirits - NPC & Monster Name Displayer" isn't installed.

I recommend you to unpack the mod since there are some files that you may need to copy into your mod and it can help you to understand better what you need to patch.

Naming rules for hostile NPCS:
I set a fixed name for generic hostile NPCs(bandits, zombies, lackeys, etc) since in most video games only important hostile NPCs have name to highlight their importance over mobs.

The name displayer picks any of the following configuration of the NPC as their name:

• npcname variable.
  
• name variable that can be assigned within their identity table.
  
• the random generated name that is assigned to them.

This is a personal preference but you may want to set a name for generic hostile NPCs(Zombies, Bandits, Lackeys, etc) that act as monsters.

The title displayer picks the following variable that is added by this mod which is harmless:

• displayTitle

There is also a new harmless behaviour script that is added by this mod that you must copy if there is an NPC that is overriding the base behaviour script(Merchants for example), you can find it here:

• /scripts/bookofspirits/bookofspirits_interact_support.lua

This script shows the displayer when interacting(E) with an NPC. If the displayer doesn't shows up when interacting, you need to add this script to your NPC.

The following is the patching proccess but you can add it directly into your mod, i think that is easier to understand the variable positions this way.

To give an NPC a title and if is overriding the behaviour script(IE: merchant.npctype):

Result:

To set a fixed name for the npc(mutantminer.npctype):

Result:

The following variables and script are harmless and are added by this mod:

The name displayer picks the following configuration of the object as their npc name:

• npcName

The title displayer picks the following variable that is added by this mod which is harmless:

• displayTitle

There is also a new script that that you must copy into your mod:

• /scripts/bookofspirits/bookofspirits_interact_support.lua

This script shows the displayer when interacting(E) with an Object. If the displayer doesn't shows up when interacting, you need to add this script to your Object.

Warning:

• You cannot use this feature if the object haves an "interactAction" parameter.
  
• You can only use this feature if the object can be made "chatty", usually have "scripts" and "chatOptions" arrays.

To give an object a name and title(IE: techlabscientist.object):

Result:

The name displayer picks the following configuration of the monster as their name:

• shortdescription

The title displayer picks the following variable that is added by this mod which is harmless:

• displayTitle(this is added as an statusProperties)

Note:
Rare Monsters variants have a custom title in the format(check /monsters/flyers/agrobat/iceagrobat.monstertype.patch):
^yellow; Rare Breed ^reset;

There is also a new harmless script that is added by this mod that you must copy if there is a Monster that can be set as elite or that can have dynamic custom titles and dynamic names such as Generated monsters:

• /scripts/bookofspirits/bookofspirits_monster_support.lua

There is also a new file that contains additional configurations for Generated Monsters that you must check if adding new types of generated monsters, it will be explained in more detail in their corresponding section:

• /monsters/bookofspirits_generated.config

To give a Monster a name, title and display it as elite if is configured as elite(IE: punchy.monstertype):

Result:

Generated Monsters have a whole new configuration file that contains parameters to set the name and custom title for generated monsters based on their parts.

The config file: /monsters/bookofspirits_generated.config

There is also a new script: "/scripts/bookofspirits/bookofspirits_monster_support.lua" that must be copied into your mod and added into the script array of the generated monster.

This is a JSON array of objects that contains a list of the skill types from the special skill of the monster that will be used to determine the prefix of the monster name.

• name: is the string name that will displayed along side the monster name.
  
• skillName: is the skill name type(IE: inkSprayAttack) that will be used to compare if the monster haves that skill.
  
• asSuffix(optional): if set to true, the skill name will be added after the monster name.

This contains a list with the name of the monster type and its variants. This list is used to determine the monster name and title based on the head part of the monster or an specific part pattern of your choice.

• monster type(IE: "largeflying"): the name of the list should be the name of the "type" parameter of the .monstertype file.
  
• variants: in this JSON array of objects, you put the different part combinations that the generated monster can have.

This JSON array of objects contains a series of variables which will be used to configure the generated monster name and title based on the parts given in their entry. It supports multiple parts pattern but its recommended to put entries with just the head part first.

• name: the monster name that will be displayed.
  
• title(optional): the title that will be displayed.
  
• prefix(optional): a prefix that will be added to the monster name.
  
• parts: this is an array of strings that contains the name of the folder containing the part of the monster.
  
• addSkillPrefix(optional): if set to false, it will not add an skill Prefix to the monster name.

Note:
If you want to set an specific pattern, that particular entry must have all the part types used by the monster type.
IE: largefish: uses 3 parts as configured in their "parts" array
so, the pattern should have 3 parts as well:
{"name" : "SunShark", "title" : "Large Fish Monster", "parts" : ["shark","sunfish","sunfish"]}

For this example i will use the "sb_hugebiped.monstertype" of Betabound which is a new type of generated monster.

Remember to copy "/scripts/bookofspirits/bookofspirits_monster_support.lua" into your mod in the same folder path.

To give support for a new generated monster type(add it directly into your mod or patch it if you are patching other user's mod):

Result:

Then you must patch the file "/monsters/bookofspirits_generated.config" as a file "/monsters/bookofspirits_generated.config.patch":

Result:

To add a new variant to an existing monster type(IE: largequadruped.monstertype), you must patch the file "/monsters/bookofspirits_generated.config" as a file "/monsters/bookofspirits_generated.config.patch":

Result: