DOCSEARCHbyAlgolia
Submit Docs

Narwhal Wiki

website·Indexed 30 days ago

https://narwhal.wiki

Documentation for Narwhal's suite of movement and combat mods, including Zephyr (movement mechanics like dashing, grappling, and wall jumping), Perfect Parries (PvP and PvE parrying systems), Perfect Dodges, and Double Jump. Includes installation guides, configuration commands such as /zephyrsettings and /parrymod, and developer APIs for mod integration.

Tokens
20K
Snippets
95
Records
192
Agent score
45%

What's inside Narwhal

  1. Overview of the Perfect Parries mod

    Perfect Parries is a Sekiro-inspired combat mod that introduces strategic block-timings. It implements reflections, ripostes, and stuns based on the parried entity's stamina.

  2. Overview of the Zephyr movement mod

    Zephyr is a movement, combat, and utility mod inspired by Apex Legends and Titanfall. It adds wall jumps, dashes, double jumps, grappling hooks, ziplines, and kunais. It includes a built-in API for integration with other mods and is highly configurable.

  3. Overview of the double jump! mod

    The double jump! mod enables double jumping functionality, accompanied by a front flip animation and a jumping sound effect.

  4. Overview of Wan's Wonder Weapons

    Wan's Wonder Weapons is a collection of unique relic weapons themed around lost civilizations, elemental forces, and forgotten magic, each providing distinct effects.

  5. Overview of the Perfect Dodges mod

    Perfect Dodges is a reactive dodging system for combat and movement. Well-timed dashes trigger specific animations (rolls, twirls, or flips) depending on the hit location. The mod features fully customizable animations and settings.

  6. Understand the Perfect Parries bonus effect mechanic

    The Perfect Parries mod rewards players with a bonus effect after landing a specific number of consecutive parries. The logic follows these steps:

    1. Each successful parry increments a parry counter.
    2. When the counter reaches the required threshold, a bonus effect triggers.
    3. The counter resets to zero after the effect fires.
    4. If the player exceeds the 'reset window' (time elapsed between parries), the counter resets to zero automatically.

  7. Implement a Sekiro-inspired parrying system with Perfect Parries

    Perfect Parries is a combat mod that introduces a strategic parrying system. It converts precise block-timings into reflections, ripostes, and stuns, with the effect based on the entity's parried stamina.

  8. Understand Double Jump mechanics and physics

    The Double Jump ability allows players to launch themselves in the direction they are looking while airborne. The jump is powered by two simultaneous forces: a horizontal boost of 10.0 (pushing the player forward) and a vertical boost of 15.0 (pushing the player upward). Each jump triggers a front flip animation and a custom sound effect.

  9. Understand the Entity Stamina System

    Every NPC and mob has a parry stamina system that determines when they can be staggered or fully stunned. Parrying is the most effective way to drain stamina. When an entity's stamina reaches zero, they enter a 'full stun' state. Stamina is invisible by default but can be enabled via a nameplate display.

  10. Handle PerfectCounterattackEvent for counterattack logic

    The PerfectCounterattackEvent provides data about a successful counterattack. It can be used to track statistics, trigger custom effects, or implement combo systems. The event provides the following methods:

    • getAttacker(): Returns the entity performing the counterattack (Ref<EntityStore>).
    • getTarget(): Returns the entity receiving the counterattack damage (Ref<EntityStore>).
    • getDamageMultiplier(): Returns the damage multiplier applied to the attack (float).

  11. Understand 8-Directional Dodging mechanics

    The dodge mechanic allows for directional dashes in eight directions (forward, backward, left, right, and four diagonals) based on the movement keys held at the time of trigger. If the player is standing still, the dodge defaults to a backward dash. If a hit occurs during the invincibility window, the character performs a reactive dodge animation (roll, twirl, or flip) based on the impact location.

  12. Integrate advanced movement mechanics using the Zephyr API

    Zephyr provides Apex/Titanfall-inspired movement capabilities, including wall jumps, dashes, double jumps, grappling hooks, ziplines, and kunais. The mod is designed as a library/API, allowing other mod creators to integrate these movement interactions into their own mods.