Loading repository data…
skwair / repository
Harmony is a peaceful Go module for interacting with Discord's API
A transparent discovery signal based on current public GitHub metadata.
This score does not audit code, security, maintainers, documentation quality, or suitability. Verify the repository and its current documentation before adoption.
Harmony is a peaceful Go module for interacting with Discord's API.
Although this package is usable, it still is under active development so please don't use it for anything other than experiments, yet.
Contents
Make sure you have a working Go installation, if not see this page first.
Then, install this package with the go get command:
go get github.com/skwair/harmony
Note that
go getwill always pull the latest version from the master branch before Go 1.11. With newer versions and Go modules enabled, the latest minor or patch release will be downloaded.go get github.com/skwair/harmony@major.minor.patchcan be used to download a specific version. See Go modules for more information.
package main
import (
"context"
"fmt"
"log"
"github.com/skwair/harmony"
)
func main() {
client, err := harmony.NewClient("your.bot.token")
if err != nil {
log.Fatal(err)
}
// Get information about the current user (the bot itself).
u, err := client.User("@me").Get(context.Background())
if err != nil {
log.Fatal(err)
}
fmt.Println(u)
}
For information about how to create bots and more examples on how to use this package, check out the examples directory and the tests.
For now, only some end to end tests are provided with this module. To run them, you will need a valid bot token and a valid Discord server ID. The bot attached to the token must be in the server with administrator permissions.
From a Discord client and with you main account, simply create a new server. Then, right click on the new server and get its ID.
Note that for the UI to have the
Copy IDoption when right clicking on the server, you will need to enable developer mode. You can find this option inUser settings > Appearance > Advanced > Developer Mode.
Create a bot (or use an existing one) and add it to the freshly created server.
See the example directory for information on how to create a bot and add it to a server.
Set HARMONY_TEST_BOT_TOKEN to the token of your bot and HARMONY_TEST_GUILD_ID to the ID of the server you created and simply run:
⚠️ For the tests to be reproducible, they will start by deleting ALL channels in the provided server. Please make sure to provide a server created ONLY for those tests. ⚠️
go test -v -race ./...
Step 1 and 2 must be done only once for initial setup. Once you have your bot token and the ID of your test server, you can run the tests as many times as you want.
Harmony exposes its API differently. It uses a resource-based approach which organizes methods by topic, greatly reducing the number of methods on the main Client type. The goal by doing this is to have a more friendly API which is easier to navigate.
Another key difference is in the "event handler" mechanism. Instead of having a single method that takes an interface{} as a parameter and guesses which event you registered a handler for based on its concrete type, this library provides a dedicated method for each event type, making it clear what signature your handler must have and ensuring it at compile time, not at runtime.
Each action that results in an entry in the audit log has a ...WithReason form, allowing to set a reason for the change (see the X-Audit-Log-Reason header documentation for more information).
Finally, this library has a full support of the context package, allowing the use of timeouts, deadlines and cancellation when interacting with Discord's API.
This project is licensed under the MIT License - see the LICENSE file for details.
Original logo by Renee French, dressed with the cool t-shirt by @HlneChd.
Selected from shared topics, language and repository description—not editorial ratings.
0xHy0kR1 /
HarmonyAI is a versatile Discord bot that have chat functionality. This bot is your go-to companion for a seamless and enjoyable Discord experience.
41/100 health