help option

[dchmelik]

There should be option to allow help for all users including non-idented. Many users regularly ask me for help such as for ident. addhost, and sometimes I even need to review that myself.

[Jarsky]

I have this old script I created for my channel, cause I always forget what commands are available.
Feel free to modify and use it

######################## Help Commands v1.2 ###########################

namespace eval helpcommands {
	variable version "v1.2"
	variable trigger "!botname"
	variable help_trigger "!help"
	variable alt_help_trigger "!userhelp"
	variable channel "#channel"
	variable login_url "https://login.mywebsite.com"
	variable command_format "\0033\002"
	variable separator "=============================================="
	variable topic_names {
		commands invite connect ident identify addhost key irckey self ops owners hops
	}
	variable command_lines {
		"!w <location>\017 - shows you current weather"
		"!wf <location>\017 - shows you a 3 day weather forecast"
		"!wl 0|1|2 <location>\017 - registers a weather location to your nick. 0=metric,1=imperial,2=both"
		"!tv <show name>\017 - shows you TV show info including current/next episode"
		"!l <show name>\017 - shows you TV show info for the last episode"
		"!n <show name>\017 - shows you TV show info for the next episode"
		"!movie <movie name>\017 - shows you MOVIE info including ratings"
		"!ipinfo <ip address>\017 - shows you info about the given IP Address"
		"!headlines\017 - show the latest News headlines around the world"
		"!headlines list\017 - list supported news sources you can access"
		"!headlines <provider>\017 - list top latest articles from the specified source"
		"!link <url>\017 - shows you if anyone has posted that URL before in chat"
		"!linkstats\017 - shows you the top URL spammers in the channel"
		"!linkstats <nick>\017 - shows you how many times the user has posted URLs in the channel"
	}
	variable info_lines {
		"%BOT% will automatically post the headers of URLs posted in chat"
		"%BOT% will automatically post info about YouTube videos for videos posted in chat"
	}

	if {[info exists ::env(NICK)] && $::env(NICK) ne ""} {
		variable botnick $::env(NICK)
	} else {
		variable botnick "Eggdrop"
	}

	proc notice {nick text} {
		puthelp "NOTICE $nick :$text"
	}

	proc render {text {nick ""}} {
		variable botnick
		variable login_url
		return [string map [list "%BOT%" $botnick "%LOGIN_URL%" $login_url "%NICK%" $nick] $text]
	}

	proc topic_list {} {
		variable topic_names
		return "topics: [join $topic_names {, }]"
	}

	proc show_command_list {nick} {
		variable botnick
		variable command_format
		variable separator
		variable command_lines
		variable info_lines

		notice $nick "Here is a list of commands you can use with $botnick"
		notice $nick $separator

		foreach line $command_lines {
			notice $nick "${command_format}${line}"
		}

		notice $nick $separator

		foreach line $info_lines {
			notice $nick [render $line]
		}

		notice $nick $separator
		return 0
	}

	proc topic_lines {topic} {
		switch -exact -- $topic {
			"commands" -
			"botname" {
				return [list \
					"public bot commands:" \
					"!w <location>, !wf <location>, !wl 0|1|2 <location>" \
					"!tv <show>, !l <show>, !n <show>, !movie <movie>, !ipinfo <ip>" \
					"!headlines, !headlines list, !headlines <provider>, !link <url>, !linkstats" \
					"automatic URL titles and YouTube info are enabled in #channel."]
			}
			"invite" -
			"connect" {
				return [list \
					"join the network, then message %BOT%: /msg %BOT% !invite <irc username> <irc key>" \
					"example: /msg %BOT% !invite %NICK% abc123key" \
					"your IRC username should match your current IRC nick." \
					"your IRC key is available from %LOGIN_URL%."]
			}
			"ident" -
			"identify" {
				return [list \
					"identify is usually done with NickServ after you register a nick." \
					"common syntax: /msg NickServ IDENTIFY <password>" \
					"for network-specific syntax use: /msg NickServ HELP IDENTIFY" \
					"if you are not registered yet, ask staff or register your nick first if the network allows it."]
			}
			"addhost" {
				return [list \
					"addhost is usually a NickServ/Services command, not a %BOT% command." \
					"common help syntax: /msg NickServ HELP ADDHOST" \
					"you normally need to be identified first before addhost will work." \
					"if the network restricts vhosts or host changes, ask staff for the exact process."]
			}
			"key" -
			"irckey" {
				return [list \
					"get or reset your IRC key from %LOGIN_URL%." \
					"once you have it, use: /msg %BOT% !invite <irc username> <irc key>" \
					"if your site username and IRC nick differ, use your IRC nick in the command."]
			}
			"self" {
				return [list \
					"self-authorize management command: !self +op|-op|+owner|-owner|+hop|-hop <nick>" \
					"this is restricted to authorized managers only." \
					"normal users should use !ops, !owners, or !hops if they were already added."]
			}
			"ops" {
				return [list \
					"!ops gives you channel operator if your nick is on the ops list." \
					"if it says you are not authorized, ask a manager to add you with !self +op <nick>."]
			}
			"owners" {
				return [list \
					"!owners gives you channel owner if your nick is on the owners list." \
					"if it says you are not authorized, ask a manager to add you with !self +owner <nick>."]
			}
			"hops" {
				return [list \
					"!hops gives you half-op if your nick is on the hops list." \
					"if it says you are not authorized, ask a manager to add you with !self +hop <nick>."]
			}
			default {
				return [list \
					"unknown help topic: $topic" \
					[topic_list] \
					"usage: !help <topic> or /msg %BOT% help <topic>"]
			}
		}
	}

	proc show_topic_help {nick query} {
		set query [string trim $query]
		if {$query eq ""} {
			notice $nick "public help is available to all users."
			notice $nick [topic_list]
			notice $nick [render "usage: !help <topic> or /msg %BOT% help <topic>" $nick]
			notice $nick "for the full public command list, use !botname or !help commands."
			return 0
		}

		set topic [string tolower [lindex [split $query] 0]]
		foreach line [topic_lines $topic] {
			notice $nick [render $line $nick]
		}
		return 0
	}

	proc pub_command_list {nick host hand chan args} {
		variable channel
		if {$chan ne $channel} {
			return 0
		}
		return [show_command_list $nick]
	}

	proc pub_help {nick host hand chan args} {
		return [show_topic_help $nick $args]
	}

	proc msg_help {nick host hand args} {
		return [show_topic_help $nick $args]
	}
}

bind pub - $helpcommands::trigger helpcommands::pub_command_list
bind pub - $helpcommands::help_trigger helpcommands::pub_help
bind pub - $helpcommands::alt_help_trigger helpcommands::pub_help
bind msg - help helpcommands::msg_help
bind msg - !help helpcommands::msg_help
bind msg - userhelp helpcommands::msg_help

putlog "Help commands $helpcommands::version loaded!"