A21 NPCMod and Addons (2024)

Current Stable Version: 21.1.0.20

The NPCMod is a community modding project. While initially started by Sphereii and Xyth back in A16, the team continues to grow in size every alpha. The goal of this project is to provide "Core" functionality and templates that can be reused by modders to add high functioning characters to their mods. There are 2 core modlets, both are required for this mod to work. The 0-SCore modlet contains C# code and the 0-XNPCCore contains the xml and templates.

By design this mod encourages expansion through expansion packs. Character packs focused on a entity type, for example, a 1-soldier pack or a 1-spider pack add new characters to the 0-XNPCCore. A 2-soldierfactions pack might add different factions to the 1-soldier pack, reusing those same soldier models. The sequence 0-, 1-, -2 etc. indicates there is a dependency on another modlet with a lower number prefix. Other character modders have committed to contributing additional characters that leverage this mod pack like they do to the POI (Buildings) collection called CompoPack. If you would like to join this community team, or have some features or characters to contribute, we would love to hear from you!

Features:

This mod includes a Unity Tutorial Project (available separately) containing the mods controller and templates and scripts so making new characters is easy.
NPC characters support all vanilla character features. These include Humanoid rigging, root motion animation, collision with vehicles, rag-dolling, 100's of animated reactions, limb decapitation and gore. These can also be retextured in xml to offer even more variety. There are some exceptions, especially on animals, which typically do not have ragdolls.
NPCs use a new Artificial Intelligence system called UAI. Unlike zombie AI (EAI), this system allows for advanced tasks and real time decision making based on considerations. Should the NPC attack, run, loot, follow, backup to optimized weapon range? All tasks and considerations.
Work very well as sleepers in POIs, respecting all of the POI volume properties.
Can be setup to attack on bloodmoons!
Spawn with vanilla or custom weapons just by editing xml.
Can be hired, becoming loyal companions, sharing your adventures and challenges.
Hired NPCs can be ordered to follow and stay, with full control via optional control icons.
Animals can also be hired, though don’t accept Dukes. Try meat.
NPCs have factions. Some like you, some don’t. Beware of bandits!
Hostile NPCs have additional AI so they will hunt you down more than zombies can, be warned!
No more losing your NPC. They will teleport to you if stuck, get too far away, or if configured, to your bedroll when you die.
They will follow you on foot, keeping up with you, and if you get into a vehicle, they will hide and reappear once you exit the vehicle.
They can heal themselves when its safe to do so, and there is a medic package for characters that can heal and mend others.
Low maintenance, no need to feed or water these folks, but that is a feature that could be available later.
Lifelike Idle animations while chatting and wandering were added to improve immersion. Many more will be added after initial release.
When the player/leader crouches, so do the NPCs
Scalable, modular architecture, so expanding character and new behaviors is much simpler.
Customizable pathing per NPC is available for POI designers.

New for A21

Weapon Swapping! Add player weapons (not every one is supported) to NPCs storage, and use the menu to enable that weapon.
New controller. Optimized to eliminate odd animation issues seen in A20

NPC Controls:

There are craftable player commands that will control your hired NPCs as a group.You can craft these commands by typing in NPC in your crafting menu.

Tutorial Video: NPCMod: Controlling Hired NPCs through Player Actions - YouTube
There are currently three commands:

Mode:This command is a toggle between various control modes:
Hunting(default): In this mode your NPC swill automatically target anything that it sees as being hostile towards it or yourself. You have no control over their actions besides stay and follow.
Full Control: In this mode the NPCs will not automatically target anything. It will behave as if all hostiles are threats and will only engage if you are hurt or if you start attacking one of the threats.

Stop:This command is a toggle and when paired with Full Control will make your NPCs halt or resume attacking their targets. This becomes especially useful when you feel like you or your NPCs will not survive an encounter and you want them to simply follow you so you can avoid the encounter altogether. It is also useful when you wish to travel without engaging any targets.
Help:This command is useful when you are in Full Control and want your NPCs to engage targets within 20 meters of you. If you are without ranged weapons, you want to be able to have your NPCs help you without having to either take damage or attack the hostile.

FAQ's

What happened to the CreaturePacks and NPC mod?
- They have been merged, combined and obsoleted. Now that code can be natively loaded by the game, there was no reason to keep those two separated. This version is simpler to load, maintain, and has more features than either one did.
Can I run this with EAC enable? NO, EAC must be turned off.
Can I learn how to add my own characters?
- Sure, its never been easier to learn to make characters. Lots of work went into simplifying the process, and scripts can do most of the work for you now. There are videos available to assist.
I have great ideas for more features, where do i make suggestions?
- This thread works or on Guppy's modding forum in the NPC-mod channel
I found a bug! Where do i post that?
- Please provide the info requested in the bug form found below, and post it here or on Guppy's modding Discord under the npc-mod-bug reports
Does this work on dedicated servers?
- It should, the current version tested well on dedi. All mods, cores and expansion packs MUST be loaded into BOTH the Dedi and all client Mods folders.
Have a good question? Maybe you will see it listed here soon!

Known issues:

Always use a fresh game if you update Score or NPCCore. Strange things can happen updating the cores on an existing game.
The UI needs work, some overlapping text, Sirillion has volunteered to refresh it.
Hired NPCs might Leroy Jenkins on aggressive animals, use the command interface to gain more control.
Melee NPC detection of crawlers in the grass isn’t as good as ranged, but works.
NPC ranged can sometimes not hit as well as other times. Let us know if you see a pattern.Might be debuffs accumulating.
It’s a very complex mod, expect bugs we didn’t find yet, and please report those.

BUG REPORTING FORM

Summary: (a short description of the bug)

Game Version: (A20 bxxx)

Platform: (PC / Mac)

Video Settings: (Low / Medium / High / Ultra / Custom (Custom has many combinations, so just list the settings you think are relevant to the bug if any))

Game mode: (MP host / MP client / SP / Client on Dedi)

Did you start a new game? (Yes/No) Note: do not submit a bug report until you retest your issue in a new game.

Did you validate your files? (Yes/No)

Are you using any other mods? (Yes/No) Note: Please retest without any mods loaded in a new game.

EAC off? Note: Needs to be Off.

Bug Description:

Detailed steps to reproduce the bug:

Actual result: (description of what is occurring)

Expected result: (what you expect to occur)

Installation:

Turn EAC Off!

Option 1: Download 0-XNPCCore.zip and SCore using the links below. If the download is a .zip or .7z file like the 0-XNPCCore.zip is, then unpack that compressed file and place the mod found inside into your Mods folder. SCore isnt compressed, so download that folder directly.Then load as many expansion packs as desired, unpacking the file if needed. If you are using a dedicated server, you also need to load both Core modlets into your dedi server Mods folder. So copies in both the client side Mods folder and also on the server Mods folder.

Option2: Use the modlauncher to load the 2 cores. Here is a helpful video to get you started: