> For the complete documentation index, see [llms.txt](https://maystudios.gitbook.io/maysimplerecoil/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://maystudios.gitbook.io/maysimplerecoil/readme.md).

# Welcome

Welcome to MaySimpleRecoil Documentation!\
[Get it on FAB!](https://www.fab.com/listings/98344337-dca3-4a3d-8197-71316393d13a)

## **About MaySimpleRecoil**

Welcome to the official documentation for the **MaySimpleRecoil System** – an advanced, modular recoil solution for Unreal Engine. This documentation will guide you through installation, basic setup, in-depth configuration, Blueprint and C++ integration, and advanced customization techniques. Whether you’re a designer or a developer, you’ll find detailed instructions and examples to help you get the most out of this system.

### Jump right in

<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-cover data-type="files"></th><th data-hidden></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Getting Started</strong></td><td>Setup</td><td><a href="/files/uI0SGp3chNB6ddPUGtn9">/files/uI0SGp3chNB6ddPUGtn9</a></td><td></td><td><a href="/pages/CyH2xJQs9yWJ1S8BYNav">/pages/CyH2xJQs9yWJ1S8BYNav</a></td></tr><tr><td><strong>Technical</strong></td><td>Data flow &#x26; Math</td><td><a href="/files/yoX8Yv0ZhYbz4IjVkOHw">/files/yoX8Yv0ZhYbz4IjVkOHw</a></td><td></td><td><a href="/pages/ZXxfwYY21Yz9PCv9X7ja">/pages/ZXxfwYY21Yz9PCv9X7ja</a></td></tr><tr><td><strong>Troubleshooting &#x26; FAQ</strong></td><td></td><td><a href="/files/Eo2rOml5BHTtJ8xbTcZT">/files/Eo2rOml5BHTtJ8xbTcZT</a></td><td></td><td><a href="/pages/AzyB4JMpQ1TCpxCwT809">/pages/AzyB4JMpQ1TCpxCwT809</a></td></tr></tbody></table>

## 1. Introduction

### 1.1 What Is MaySimpleRecoil System?

**MaySimpleRecoil System** is an advanced recoil solution designed for Unreal Engine projects. It delivers realistic weapon recoil by dynamically adjusting based on player states such as sprinting, crouching, jumping, and aiming down sights (ADS). With a powerful blend of Blueprint accessibility and a robust C++ backend, the system enables you to fine-tune every shot with minimal setup while offering high performance through SIMD optimizations

**Key Features:**

* **Realistic Recoil Dynamics:** Automatically adjusts recoil strength based on player conditions.
* **Fully Customizable Settings:** Modify vertical/horizontal strengths, scaling multipliers, animation speeds, and more.
* **Blueprint & C++ Integration:** Use the system out-of-the-box or extend it with your own logic.
* **Replicated Example Weapons:** See the system in action with fully networked demo weapons.
* **Editor Preview & Live Tuning:** Instantly visualize recoil patterns and tweak settings in real time.

### 1.2 Versions & Roadmap

#### **Current Version:** 1.0.0 This release includes a complete implementation of recoil initialization, timeline-driven recoil and reset animations, dynamic scaling based on character state, and a fully replicated example setup.

#### **Upcoming (Version 1.0.1):**

* Advanced procedural recoil patterns.
* Interactive UI and audio feedback tied to recoil events.
* Enhanced editor tools for even faster tuning.
* Further performance optimizations for a broader range of hardware.