astral

module
v1.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 28, 2020 License: ISC

README

Astral

A command router for discordgo with a few twists.

Heavily inspired by dgrouter, but based off the command system used in Astra.

Importing/Installing

go get meow.tf/astral
import "meow.tf/astral/router"

Signatures

Astral supports signatures, which are a command and arguments defined in a single string.

Example:

command <something> <#channel> [optional]

This defines a command command, with required argument something, channel argument channel, and optional optional.

Middleware

Each route can have middleware assigned to back out/stop execution of a command. This is useful for injecting parameters, checking conditions (Permissions, NSFW), etc.

See the "middleware" folder for examples.

Examples

A basic example showing the usage and middleware is available under examples/basic

Directories

Path Synopsis
examples

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL