## RagnarsRökare MobAILib ##
MobAILib is a library that can used to replace the built in AI of Characters inside Valheim.
The goal is to provide a range of AI types and behaviours that can be used by modders to create a more living world.

### Usage ###
Start by adding a reference to MobAILib inside your mod-project.

The RagnarsRokare.MobAI.MobManager is used to register and keep track of controlled mobs.
It has a list of available MobAIs to use as the "brain" of the mob and controls its actions.
Each MobAI has its own config file with settings.
They inherit MobAIBaseConfig that contain the base attributes:
**Awareness** - General awareness, used to calculate search ranges and ability to detect enemies
**Agressiveness** - Agressivness determines how to behave when fighting and when to give up and flee
**Mobility** - Mobility is used to determine how often and how far the mob moves
**Intelligence** - General intelligence, how much the mob can remember


- **WorkerAI**
Makes the character walk around and refill Smelters, Kilns, Fireplaces and Torches. It will search for items on the ground and in chests.
Will fight if hurt but give up easily (has low aggression level). The FeedDuration setting only applies if there is a Tameable component attached to the gameObject.
**WorkerAIConfig**
public int FeedDuration = 1000;
public string[] IncludedContainers = new string[] { "piece_chest_wood" };
public int TimeBeforeAssignmentCanBeRepeated = 120;
public int TimeLimitOnAssignment = 60;

- **FixerAI**
Makes the character go and repair any damaged structures it finds. It will equip the item from position 0 in inventory or Hammer if it exists and use its attack animation when reapairing. Will fight aggressively if hurt (has high aggression level).
The FeedDuration setting only applies if there is a Tameable component attached to the gameObject.
**FixerAIConfig**
These are the default values
public int PostTameFeedDuration = 1000;
public int TimeLimitOnAssignment = 30;
public string[] IncludedContainers = new string[] { "piece_chest_wood" };

- **SorterAI**
Makes the character pickup items and put them in containers that already contain an item of the same type or that has the item noted on a sign
close to the container. It will also pickup whatever items is in an assigned "dump" container and sort them. They can also be taught to interact with
with pickable objects like branches, flint and berries.
**SorterAIConfig**
These are the default values
public int PostTameFeedDuration = 1000;
public int MaxSearchTime = 30;
public string[] IncludedContainers = new string[] { "piece_chest_wood" };


**``RegisterMobAI(Type mobAIType)``**
Used to register a custom MobAI
mobAIType must be a class that inherit MobAIBase and implement the IMobAIType interface
See wiki at [GitHub](https://github.com/di98feja/RagnarsRokare/wiki) for an example mobAI implementation.

**``RegisterMob(Character character, string uniqueId, string mobAIName, string configAsJson)``**
Used to register a mob to use a MobAI.
- character is the Character component of the mob
- uniqueId is a string that is used to uniquely identify the mob among all other mobs
- mobAIName is the type of MobAI to be used. Available types can be found via **``MobManager.GetRegisteredMobAIs()``**
- configAsJson is the MobAI specific config serialized as JSON

**``RegisterMob(Character character, string uniqueId, string mobAIName, object config)``**
Used to register a mob to use a MobAI.
- character is the Character component of the mob
- uniqueId is a string that is used to uniquely identify the mob among all other mobs
- mobAIName is the type of MobAI to be used. Available types can be found via **``MobManager.GetRegisteredMobAIs()``**
- config is the MobAI specific config

**``UnregisterMob(string uniqueId)``**
Used to stop controlling a mob.

**``IsRegisteredMob(string uniqueId)``**
Check if there is a registered mob by the given uniqueId.

**``IsAliveMob(string uniqueId)``**
Check if there is an active mob by the given uniqueId.
A mob is Alive when its MobAI has been instanciated and assigned.

**``Dictionary AliveMobs``**
All Alive mobs is kept in a dictionary with their UniqueId as key.
Value is the baseclass of its MobAI that give access to its CurrentAIState


The code can be found at [GitHub](https://github.com/di98feja/RagnarsRokare)
In that repository is also the SlaveGreylings mod which uses this library.

Under the hood we use (or perhaps misuse) the Stateless state machine (also found at [GitHub](https://github.com/dotnet-state-machine/stateless)).
Thank you stateless team!


The MobAILib is a work in progress and as all hobby endeavors there is limit to how much time we have to spend on this project, no matter how fun we think it is.
So even if we love feedback we will not be able to suit everybodys wishes, atleast not right away...

// Barg and Morg

### Future plans ###
- Add more specialized Fighting-behaviours that can be used by all MobAI-classes
- Add Interface and Strategy pattern for runtime selection of fightingBehaviour
- More built-in MobAI classes
- More common behaviours

### Changelog ###
- Version 0.3.4
Updated for Hearth&Home

- Version 0.3.3
Bugfix

- Version 0.3.2
Made Sorter less eager to find new task

- Version 0.3.1
Made backwards compatible with v0.2

- Version 0.3.0
Added markers for mobs on map
Various tweaks and stability improvements
RoamingAI disabled by default. It works well in single player and when alone on dedicated server. Needs work in multiplayer.

- Version 0.3.0-preRelease
Added SorterAI and ItemSortingBehaviour
Added configurable strings for AIState messages
Added RoamingAI: mobs do not need a player near to be active
Added Pickable interaction, can be taught to Sorters

- Version 0.2.0
Added base mob attributes to control behaviours.
Line of sight required for containers and assignments.
Added FeedingBehaviour, removed the need for Tameable component
Reworked Statemachine tree
Deprecated some config values

- Version 0.1.3
Added basic FightingBehaviour to FixerAI and WorkerAI
Fixed error when adding fuel to fireplaces with no mob on follow

- Version 0.1.2
Added ability to register custom MobAI-classes

- Version 0.1.1
Added overload for RegisterMob that takes the config as an object

- Version 0.1.0
First release