GrueBot

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

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

Go to latest
Published: Nov 11, 2020 License: BSD-2-Clause Imports: 10 Imported by: 0

README

GrueBot

A Discord bot that allows you to use dfrotz to play Z-machines

Building

To build GrueBot, run make build. To build with debugging symbols, run make build-debug.

Running

Gruebot's usage is ./gruebot /path/to/game.

Here is an example gruebot.json. Gruebot needs one in order to run

{
	"frotzPath": "/path/to/dfrotz",
	"discordToken": "yourdiscordtokenhere",
	"serverID": "getserveridandputithere",
	"gameChannel": "channelinserver",
	"testingChannel": "channelfortestingiftestingModeistrue",
	"testingMode": false,
	"botOwnerID": "yourDiscordID"
}

Note that GrueBot specifically requires a "dumb" build of Frotz, without ncurses support. Using the mainline build will likely not work.

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