README
¶
An open source, general purpose modular Discord bot written in go.
Project is still in very early stages and documentation is incomplete/nonexistent in most parts, here will be a way to get started if you want to contribute.
Special Thanks
Rogue (artist)
Building
GNU make is required, FreeBSD's make implementation simply does not work. You also need the go compiler.
To build the project, just run make in the root of the project, binaries are produced in build/. After building for the first time you can skip the dependency part and have make automatically start Nitori by doing make run.
Running
Nitori produces a configuration file if not present and exits, make sure to edit that file and fill in your stuff before running again.
Discussion
We currently have a Discord guild for discussions on development of this project, however any topic is OK.
Directories
¶
| Path | Synopsis |
|---|---|
|
internal
|
|
|
badger
Badger database backend.
|
Badger database backend. |
|
nitori
|
|
|
config
Functions to interact with global and guild-specific configuration values.
|
Functions to interact with global and guild-specific configuration values. |
|
embedutil
Embed formatting utility.
|
Embed formatting utility. |
|
log
Logging functions and logger object.
|
Logging functions and logger object. |
|
multiplexer
Integrated command handlers.
|
Integrated command handlers. |
|
state
Variables containing important information.
|
Variables containing important information. |
|
plugins
|
|
|
feels
Plugin example.
|
Plugin example. |
|
Server program.
|
Server program. |
|
database
Wrapper around database backend driver.
|
Wrapper around database backend driver. |
|
discord
Discord-related services.
|
Discord-related services. |
|
web
Web services.
|
Web services. |
|
web/jsontypes
Structs used for JSON marshalling by the web server.
|
Structs used for JSON marshalling by the web server. |