> For the complete documentation index, see [llms.txt](https://ferra13671-dev.gitbook.io/projects/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://ferra13671-dev.gitbook.io/projects/main/cometrenderer-documentation/crm/about.md).

# About

**CRM** (CometRenderer Mod) is a library mod that provides various utilities for using CometRenderer within Minecraft.

CRM includes:

* CometRenderer and its automatic initialization.
* ['better-compiler' plugin](/projects/main/cometrenderer-documentation/plugins/better-compiler.md) and its automatic initialization.
* Basic set of [programs](/projects/main/cometrenderer-documentation/crm/basic-programs.md) and [PrimitiveBatches](/projects/main/cometrenderer-documentation/crm/primitivebatches.md).
* Set of [events](/projects/main/cometrenderer-documentation/crm/events.md).
* Implementation for loading Minecraft textures and buffers into CometRenderer uniforms.
* Implementation that allows you to use framebuffers from Minecraft in CometRenderer (MinecraftFramebuffer).
* Ability to use stencil in all Minecraft framebuffers.

The mod requires the [Fabric API](https://modrinth.com/mod/fabric-api) to work.

### Adding a dependency

{% code title="build.gradle" lineNumbers="true" %}

```groovy
repositories {
    maven {
        name = 'ferra13671-maven'
        url = 'https://ferra13671.github.io/maven/'
    }
}

dependencies {
    modImplementation "com.ferra13671:crm:${crm_version}"
    //Include CRM as a Jar-in-Jar dependency (optional)
    include "com.ferra13671:crm:${crm_version}"
}
```

{% endcode %}

{% code title="gradle.propertoe" lineNumbers="true" %}

```groovy
crm_version = x //checkout version in releases (https://github.com/Ferra13671/CometRenderer/releases)
```

{% endcode %}