Velvet

Velvet is a multi-loader environment library for developing and employing custom OpenGL shaders, built upon the Satin framework. It's recommended to support the creators of the Satin project, but please report any technical difficulties occurring specifically with Velvet through the appropriate support channels.

All essential reference materials are available on the Satin wiki page. Certain classes and methods within this library have undergone renaming to conform to Mojang's standard nomenclature.

Integrating Velvet into Your Project

For Fabric-based projects utilizing just a single mod type, consider employing a direct installation of the Satin library integration.

To configure Velvet, implement the following segment within your project setup file:

repositories {
    maven {
        name = "Up-Mods & Cammie's Corner"
        url = "https://maven.uuid.gg/releases"
    }
}

Specific directions for Fabric (required only when providing unique support for this mod type):

dependencies {
    modImplementation "dev.cammiescorner.velvet:Velvet-Common:${velvet_version}"
    modImplementation "dev.cammiescorner.velvet:Velvet-Fabric:${velvet_version}"

    // Optional section for bundling library components
    include "dev.cammiescorner.velvet:Velvet-Common:${velvet_version}"
    include "dev.cammiescorner.velvet:Velvet-Fabric:${velvet_version}"
}

Required configuration for NeoForge:

dependencies {
    implementation "dev.cammiescorner.velvet:Velvet-Common:${velvet_version}"
    implementation "dev.cammiescorner.velvet:Velvet-NeoForge:${velvet_version}"

    // Typical inclusion pattern jar-related options
    jarJar("dev.cammiescorner.velvet:Velvet-Common:${velvet_version}") {
        transitive = false
        version {
            strictly "[${velvet_version},)"
            prefer ${velvet_version}
        }
    }
    jarJar("dev.cammiescorner.velvet:Velvet-NeoForge:${velvet_version}") {
        transitive = false
        version {
            strictly "[${velvet_version},)"
            prefer ${velvet_version}
        }
    }
}

You need to specify the correct properties segment in gradle.properties:

# Velvet specification
velvet_version=0.x.x

Similarly, for projects utilizing the TOML structure file:

# Velvet specification
velvet_version = "0.x.x"

The current available package release can always be checked at the project's dedicated GitHub Releases page.