janitorjeff

command module
v0.0.0-...-e03fed0 Latest Latest
Warning

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

Go to latest
Published: Nov 20, 2022 License: AGPL-3.0 Imports: 17 Imported by: 0

README

JanitorJeff

Go Reference

A general purpose, cross-platform bot.

Very much under active developement, there will most likely be breaking changes.

Structure

There's 3 main components to the bot:

The frontend layer is responsible for providing methods for working with a specific frontend (receiving messages, sending messages, etc.). An interface exists in the core and for a frontend to be added it must implement that interface.

The message layer is responsible for creating a common struct under which all messages from all frontends are processed.

The command layer where all of the actual commands are implemented. For most use cases it is frontend agnostic, an exception is discord because of the special "rendering" the messages get (embeds as opposed to plain text). An interface exists in the core and for a command to be added it must implement that interface.

Documentation

The Go Gopher

There is no documentation for this package.

Jump to

Keyboard shortcuts

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