https://github.com/austinv11/harmony

https://github.com/austinv11/harmony

Last synced: 2 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/austinv11/harmony
• Owner: austinv11
• License: gpl-3.0
• Created: 2020-05-21T16:47:52.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2020-06-03T02:36:59.000Z (over 4 years ago)
• Last Synced: 2023-08-13T09:06:52.860Z (over 1 year ago)
• Language: Kotlin
• Size: 255 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Harmony

An opinionated Java/Kotlin framework for building chat

bots for Discord easily. 

While it's simple to use, it makes no concessions on 

performance due it being built on 

[Discord4J](https://discord4j.com) and 

[Reactor](https://projectreactor.io/). Stop worrying

about implementing command parsing and dispatching,

just focus on the fun of making commands!

While a large portion of the internals are built with 

Kotlin, Harmony is still designed to allow for idiomatic

use in Java. Kotlin is simply the preferred language 

since it allows for lots of boilerplate to be excluded.

## Features

* Statically define commands with aspect-oriented programming 

(i.e. use annotations on your classes to define properties.)

* DSL for defining commands imperatively

* Automatic command discovery and registration

* Typo detection and correction

* Automatic help command handling

* Robust argument parsing

* Automatic message <-> Java object mapping

* Built-in error handling/recovery

* A specialized launcher allows for in place bot restarts

* Ability for dynamic command prefixes on a per-channel basis

## Example: Minimal bot

Goal: Make a bot which can respond to `@BotName ping`

with `Pong!`

### Kotlin

MyBot.kt

```kotlin

import harmony.Harmony

import harmony.command.annotations.Command

import harmony.command.annotations.Help

import harmony.command.annotations.Responder

fun main(args: Array) {

    Harmony(token = args[0]) // Instantiation implicitly logs in and wires all commands

        .awaitClose() // Look mom, no wiring code!

}

// Commands are automatically discovered by Harmony at compile time

@Help("Responds to you with 'pong'!") // Integrate documentation with your code

@Command class PingCommand { // Class name can implicitly determine the command name

    

    // Register handlers with @Responder and Harmony will map given arguments to the best fitting command handler

    // Harmony will also transform return values into a reply if possible/logical to do so

    @Responder fun respond() = "Pong!"

}

```

### Equivalent Java code:

MyBot.java

```java

import harmony.Harmony;

public class MyBot {

    

    public static void main(String[] args) {

        new Harmony(args[0])

            .awaitClose();

    }

}

```

PingCommand.java

```java

import harmony.command.annotations.Command;

import harmony.command.annotations.Help;

import harmony.command.annotations.Responder;

@Help("Responds to you with 'pong'!")

public @Command class PingCommand {

    public String @Responder respond() {

        return "Pong!";

    } 

}

```