Requires: Animation Manager

For other modders

Would be nice to collaborate on combat related mod. Would be nice to have somebody to test features, to animate player and items, may be even to write some code, or just do research part. 

Description:

Library for adding melee weapons with collision based hit detection and block with perfect block mechanic. On its own just adds this functionality to vanilla shields, spears and swords (optional, can be turned off with config lib). In the future, Spears and Swords mods will use this instead of FSMlib. For details of how to use it, feel free to ping me in official VS discord server.

Library has two already implemented classes for sword-like and spear-like weapons, you need only json to use them. But also, the library provides a powerful tool for implementing your own custom control schemes using its C# API.

Example of implementing vanilla like weapon control scheme: link to github.

Features for players:

On its own, this mod reworks vanilla swords, spears and shields. It leaves vanilla animations and balance for weapons, but shields are rebalanced due to having a different mechanic. Due to being early in development, sounds for attacks are missing, will be fixed soon. All these features can be turned off individually using Config lib.

• Collision based hit detection for swords and spears - changes how weapons interact with enemies. Now you have to aim your weapon model when attacking instead of selecting an entity with reticle. Ranged is based on animations and weapon length and not just hardcoded value. Reticle color does not indicate if enemy is in reach anymore.
• Hit multiple enemies with single attack - if while attacking your weapon goes through several enemies, all of them will receive damage
• Block with shield using RMB instead of sneak - now to block with shield you have to hold it in offhand and press Right Mouse Button (or some other button if you remapped it) to block enemy attack. Shield no longer provide passive protection.
• Cant block enemies behind you - now shields can block only attack coming from 240 degrees arc in front of you
• Perfect block - if you press block right before an enemy attack, you will perform a perfect block that will block 100% of the damage, sound of successful perfect block is also different

Features for modders:

• Collision based hit detection instead of vanilla mechanism of selecting entity's selection box. Each weapon can have multiple colliders that will collide with entities and terrain, and you can decide what to do in each case, you will also get point of intersection between collider and entity or terrain collision boxes. You can play sounds, spawn particles, stop attacks, play stagger animations - and all the other stuff.
• Attack direction selector - each weapon can specify a set of direction that can be selected like in Mordhau or For Honor games, it will be passed to your methods that handles attacks, and you can choose what animation to play (in the future directional blocking for players will be added, so it will move pvp closer to mentioned games)
• Block and Perfect Block - adds more traditional blocking system (with also directional block), block set amount of damage, if timed right will block all damage (perfect block), can have different coverage (direction from attacker to attacked is compated with attacked line of sight, and checked against coverage angles of block being used, default is +-120 deg in pitch and yaw)
• Custom control schemes - the library provides a convenient and easy way to implement any control scheme. You can add handlers to any events from EnumEntityAction enum, and action state (like being pressed, active, inactive, released or held).
• Animation Manager lib based animations with more procedural control and entity behavior that manages them and makes sure that player won't stack in animation after death or in any other case of weapon disappearing from player's hands, same goes for stats (like movement speed).
• Synchronization - weapon logic is purely client side and only for the player that runs the client. All the synchronization and validation is done by the library. It makes it much easier to manage more complex weapons.