Skip to content
This repository has been archived by the owner on Mar 19, 2024. It is now read-only.

HyacinthBots/discord-moderation-actions

Repository files navigation

⚠️ This project is archived. It proved too much of a development burden, which was the opposite of what it set out to achieve. There will be no future updates to this project. ⚠️

Discord Moderator Actions

WIP Library for the Kord(Ex) Discord Libraries that provides a single DSL that will execute the moderation action, dm the user concerned about it, log it to channel.

This project is licensed under the MIT License

Usage instructions

Latest version:

Adding the dependency:

Maven:

<!-- Optioanlly adding the snapshot repository repository -->
<repositories>
    <repository>
        <id>Sonatype snapshots</id>
        <url>https://s01.oss.sonatype.org/content/repositories/snapshots/</url>
    </repository>
</repositories>

        <!-- Adding the dependency. Replace TAG with the latest version -->
<dependency>
<groupId>org.hyacinthbots</groupId>
<artifactId>discord-moderation-actions</artifactId>
<version>TAG</version>
</dependency>

Gradle (Groovy):

repositories {
    mavenCentral()
    // Optionally add the snapshots repo
    maven {
        name = 'Sonatype snapshots'
        url = 'https://s01.oss.sonatype.org/content/repositories/snapshots/'
    }
}

// Adding the dependency. Replace TAG with the latest version
dependencies {
    implementation('org.hyacinthbots:discord-moderation-actions:TAG')
}

Gradle (Kotlin):

repositories {
    mavenCentral()
    // Optionally add the snapshots repository
    maven {
        name = "Sonatype snapshots"
        url = uri("https://s01.oss.sonatype.org/content/repositories/snapshots/")
    }
}

// Adding the dependency. Replace TAG with the latest version
dependencies {
    implementation("org.hyacinthbots:discord-moderation-actions:TAG")
}

Getting started

Once you have added the dependency to your project, you're fully ready to start using Discord Moderation Actions (DMA). There is no specific configuration required for DMA, as all configuration for actions is done within the chosen action DSL.

NOTE: This project requires KordEx currently. Maybe in the future support for vanilla Kord will be added

Examples and full documentation can be found in the Wiki

Reporting Issues and Requesting features

If you have any issues to report or features to request, please open an issue on the GitHub Issue Tracker. I request that you follow the template provided and provide as much information as possible. Issues that don't follow the template will simply be closed and ignored.