func emojiHelpFunc(bot *bruxism.Bot, service bruxism.Service, message bruxism.Message, detailed bool) []string {
help := bruxism.CommandHelp(service, "emoji", "<emoji>", "Returns a big version of an emoji.")
if detailed {
help = append(help, bruxism.CommandHelp(service, "hugemoji", "<emoji>", "Returns a huge version of an emoji.")[0])
}
return help
}
// Help returns a list of help strings that are printed when the user requests them.
func (p *triviaPlugin) Help(bot *bruxism.Bot, service bruxism.Service, message bruxism.Message, detailed bool) []string {
if service.IsPrivate(message) || !(service.IsModerator(message) || service.IsBotOwner(message)) {
return nil
}
return []string{
bruxism.CommandHelp(service, "trivia", "<start|stop> [theme]", "Starts or stops trivia with an optional theme.")[0],
bruxism.CommandHelp(service, "trivia", "<score>", "Returns your current trivia score.")[0],
}
}
// Help returns a list of help strings that are printed when the user requests them.
func (p *livePlugin) Help(bot *bruxism.Bot, service bruxism.Service, message bruxism.Message, detailed bool) []string {
if detailed {
return []string{
bruxism.CommandHelp(service, "live", "add [youtube channel id]", "Adds a channel to be announced.")[0],
bruxism.CommandHelp(service, "live", "remove [youtube channel id]", "Removes a channel from being announced.")[0],
bruxism.CommandHelp(service, "live", "list", "Lists all the channels being announced in this channel.")[0],
}
}
return bruxism.CommandHelp(service, "live", "<add|remove|list> [youtube channel id]", "Announces when a YouTube Channel goes live.")
}
func (p *chartPlugin) helpFunc(bot *bruxism.Bot, service bruxism.Service, message bruxism.Message, detailed bool) []string {
help := bruxism.CommandHelp(service, "chart", "<up|down|flat> <vertical message>, <horizontal message>", "Creates a chart trending in the desired direction.")
if detailed {
help = append(help, []string{
"Examples:",
bruxism.CommandHelp(service, "chart", "down interest, time", "Creates a chart showing declining interest over time")[0],
}...)
}
return help
}
// Help returns a list of help strings that are printed when the user requests them.
func (p *playedPlugin) Help(bot *bruxism.Bot, service bruxism.Service, message bruxism.Message, detailed bool) []string {
if detailed {
return nil
}
return bruxism.CommandHelp(service, "played", "[@username]", "Returns your most played games, or a users most played games if provided.")
}
// Help returns a list of help strings that are printed when the user requests them.
func (p *playingPlugin) helpFunc(bot *bruxism.Bot, service bruxism.Service, message bruxism.Message, detailed bool) []string {
if detailed {
return nil
}
if !service.IsBotOwner(message) {
return nil
}
return bruxism.CommandHelp(service, "playing", "<game>, <url>", fmt.Sprintf("Set which game %s is playing.", service.UserName()))
}
// Help returns a list of help strings that are printed when the user requests them.
func (p *ReminderPlugin) Help(bot *bruxism.Bot, service bruxism.Service, message bruxism.Message, detailed bool) []string {
help := []string{
bruxism.CommandHelp(service, "reminder", "<time> <reminder>", "Sets a reminder that is sent after the provided time.")[0],
}
if detailed {
help = append(help, []string{
"Examples: ",
p.randomReminder(service),
p.randomReminder(service),
}...)
}
return help
}
// Help returns a list of help strings that are printed when the user requests them.
func (p *comicPlugin) Help(bot *bruxism.Bot, service bruxism.Service, message bruxism.Message, detailed bool) []string {
help := bruxism.CommandHelp(service, "comic", "[1-10]", "Creates a comic from recent messages, or a number of messages if provided.")
ticks := ""
if service.Name() == bruxism.DiscordServiceName {
ticks = "`"
}
if detailed {
help = append(help, []string{
bruxism.CommandHelp(service, "customcomic", "[id|name:] <text> | [id|name:] <text>", fmt.Sprintf("Creates a custom comic. Available names: %s%s%s", ticks, strings.Join(comicgen.CharacterNames, ", "), ticks))[0],
bruxism.CommandHelp(service, "customcomicsimple", "[id:] <text> | [id:] <text>", "Creates a simple custom comic.")[0],
"Examples:",
bruxism.CommandHelp(service, "comic", "5", "Creates a comic from the last 5 messages")[0],
bruxism.CommandHelp(service, "customcomic", "A | B | C", "Creates a comic with 3 lines.")[0],
bruxism.CommandHelp(service, "customcomic", "0: Hi! | 1: Hello! | 0: Goodbye.", "Creates a comic with 3 lines, the second line spoken by a different character")[0],
bruxism.CommandHelp(service, "customcomic", "tiki: Hi! | jordy: Hello! | tiki: Goodbye.", "Creates a comic with 3 lines, containing tiki and jordy.")[0],
bruxism.CommandHelp(service, "customcomicsimple", "0: Foo | 1: Bar", "Creates a comic with 2 lines, both spoken by different characters.")[0],
}...)
}
return help
}
func (p *streamerPlugin) helpFunc(bot *bruxism.Bot, service bruxism.Service, message bruxism.Message, detailed bool) []string {
if detailed {
return nil
}
return bruxism.CommandHelp(service, "streamer", "<streamername|streamerid>", "Grabs details about a YouTube streamer.")
}
func avatarHelpFunc(bot *bruxism.Bot, service bruxism.Service, message bruxism.Message, detailed bool) []string {
if detailed {
return nil
}
return bruxism.CommandHelp(service, "avatar", "[@username]", "Returns a big version of your avatar, or a users avatar if provided.")
}
// Help returns a list of help strings that are printed when the user requests them.
func (p *MusicPlugin) Help(bot *bruxism.Bot, service bruxism.Service, message bruxism.Message, detailed bool) []string {
// Only show help messages for guilds where we have a voice connection
c, err := p.discord.Channel(message.Channel())
if err != nil {
log.Println("musicplugin: fetching channel err:", err.Error())
return nil
}
_, ok := p.VoiceConnections[c.GuildID]
if !ok {
return nil
}
help := []string{
bruxism.CommandHelp(service, "music", "<command>", "Music Plugin, see `help music`")[0],
}
if detailed {
help = append(help, []string{
"Examples:",
bruxism.CommandHelp(service, "music", "join [channelid]", "Join your voice channel or the provided voice channel.")[0],
bruxism.CommandHelp(service, "music", "leave", "Leave current voice channel.")[0],
bruxism.CommandHelp(service, "music", "play [url]", "Start playing music and optionally enqueue provided url.")[0],
bruxism.CommandHelp(service, "music", "info", "Information about this plugin and the currently playing song.")[0],
bruxism.CommandHelp(service, "music", "pause", "Pause playback of current song.")[0],
bruxism.CommandHelp(service, "music", "resume", "Resume playback of current song.")[0],
bruxism.CommandHelp(service, "music", "skip", "Skip current song.")[0],
bruxism.CommandHelp(service, "music", "stop", "Stop playing music.")[0],
bruxism.CommandHelp(service, "music", "list", "List contents of queue.")[0],
bruxism.CommandHelp(service, "music", "clear", "Clear all items from queue.")[0],
}...)
}
return help
}
func (p *topStreamersPlugin) helpFunc(bot *bruxism.Bot, service bruxism.Service, message bruxism.Message, detailed bool) []string {
if detailed {
return nil
}
return bruxism.CommandHelp(service, "topstreamers", "", "List the current top streamers on YouTube Gaming.")
}