FreeNitori

module

v0.2.1 Latest Latest Go to latest Published: Dec 8, 2020 License: GPL-3.0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

git.randomchars.net/RandomChars/FreeNitori

Links

Open Source Insights

README ¶

FreeNitori

Download latest build

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 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 Plugin example.	Plugin example.
server Server program.	Server program.
database Wrapper around database backend driver.	Wrapper around database backend driver.
database/vars
discord Discord-related services.	Discord-related services.
discord/embedutil Embed formatting utility.	Embed formatting utility.
discord/handlers Integrated command handlers.	Integrated command handlers.
discord/multiplexer Command multiplexer.	Command multiplexer.
discord/vars
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.

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