# Welcome!

## 🛠 Welcome to Distorted Vigil Modding

Welcome to the official modding documentation for **Distorted Vigil**.

My goal is to create an atmospheric and terrifying experience that is also a playground for creators. We believe that the community's creativity is what keeps a horror game alive, which is why we've designed our systems to be as **modular** and **accessible** as possible.

#### 🌑 Why Mod Distorted Vigil?

Our codebase is built on top of **FishNet**, ensuring state-of-the-art multiplayer synchronization. By creating mods for this project, you are working with a system that handles the "heavy lifting" of networking for you, allowing you to focus purely on the gameplay and atmosphere.

***

#### 📂 Current Available Modules

Currently, you can start diving into:

{% content-ref url="/pages/6DB6VIUVFwNH7cfY7qyY" %}
[Modding Categories](/distorted-vigil-modding-docs/modding-categories/sanity-events.md)
{% endcontent-ref %}

***

#### 🚧 What's Coming Next? (Roadmap)

We are constantly documenting our internal systems to give you more power. In the near future, we will add detailed guides on:

* 🆔 **Mod Metadata:** How to properly name your mods, add author info, and versioning.
* 👁️ **Post-Processing Effects:** Creating unique visual shaders for insanity and environmental hazards.
* 🌐 **Multiplayer Sync:** Advanced techniques for synchronizing custom mod data across the network.

{% hint style="info" %}
We'll be adding a lot more stuff to the Roadmap.. it's not just these 3 goals, don't worry!
{% endhint %}

#### 🤝 Join the Community

Stay tuned for more updates. We can't wait to see the nightmares you will create!

> **Getting Started:** If you are new here, we recommend starting with the 
>
> **Sanity Event** page to understand our basic modding architecture.


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://horizons-studios.gitbook.io/distorted-vigil-modding-docs/welcome.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.