README
¶
FreeNitori
FreeNitori is a general purpose Discord bot written in Golang.
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.
Download that archive from the URL above, extract it somewhere, run freenitori-supervisor or freenitori (they are both the supervisor program) once, and edit the configuration file, fill in the credentials and replace the default binary paths to the locations you placed FreeNitori binaries, then run the supervisor program again.
When using the Makefile, remember to run make at least once then use make run in development (which remove an extra downloading stage and automatically starts the program).
Directories
¶
| Path | Synopsis |
|---|---|
|
internal
|
|
|
badger
command
Badger database backend.
|
Badger database backend. |
|
nitori
|
|
|
args
Package args provide the means to parse arguments early when imported.
|
Package args provide the means to parse arguments early when imported. |
|
config
Functions to interact with global and guild-specific configuration values.
|
Functions to interact with global and guild-specific configuration values. |
|
log
Logging functions and logger object.
|
Logging functions and logger object. |
|
state
Variables containing important information.
|
Variables containing important information. |
|
plugins
|
|
|
feels
command
Plugin example.
|
Plugin example. |
|
discord/embedutil
Embed formatting utility.
|
Embed formatting utility. |
|
discord/handlers
Integrated command handlers.
|
Integrated command handlers. |
|
discord/multiplexer
Command multiplexer.
|
Command multiplexer. |
|
discord/vars
Important chatbackend-specific variables.
|
Important chatbackend-specific variables. |
Click to show internal directories.
Click to hide internal directories.