Configuration:Base

From ShoutIRC RadioBot Wiki
Jump to: navigation, search
Configuration Sections vde

ircbot.conf Format
RadioBot Sections
Base
Example
IRC
Example
SS
Example
Timer Plugin
Most Popular Plugin Sections
AutoDJ SAM
Example
SimpleDJ DCC
Example
TTS
Example
Welcome
Other Plugin Sections
Auto_Identify Centovacast
Example
ChanAdmin
Example
ChannelLinking Forum Jabber
Hangman LastFM Logging LevelEmul Mumble
Example
phpBB
Example
Pidgin PublicVote SC_Proxy ShowSchedule Skype SMS
SS_Admin TeamSpeak3
Example
Telnet Trivia TuneIN
Example
Twitter
Example
Uno Users_MySQL
Example
Users_Shared


Base

Nick			BotNickname
Mandatory
This sets the nickname the bot should use on IRC.
RegName			Your license name
Mandatory
RegKey			Your license key
Mandatory
LangCode		en_US
Optional
This will let you force the bot to use a certain language code. Useful if your locale is misdetected or set incorrectly, or if you want to use a custom language file.
DJName			Nick
DJName			Username
DJName			Standard
Optional
This will let you change how the bot determines the DJ name when there is an active DJ or when a source plugin is playing. Nick will use the DJ's current nick, Username will use the DJ's RadioBot username, or Standard will use the normal way RadioBot does it and pull the info from your sound server. When there is no active DJ the bot also uses Standard mode since there is no way to tell the DJ name other than through your sound server.
OnlineBackup		1
Optional
This will backup your RadioBot configuration files on the ShoutIRC.com server automatically so you can retrieve copies of them at any time.
SecsBetweenUpdates	30
Mandatory
This sets how often your media servers should be polled for stats, 30 seconds is usually a good default. (minimum: 15)
DoSpam			1
Mandatory
This sets whether the bot should send song updates, etc. on a global basis.
DoTopic		1
Mandatory
This sets whether the bot should manage channel topics on a global basis.
DoOnjoin		1
Mandatory
This sets whether the bot should send OnJoin greetings on a global basis.
EnableRating			0 or 1
Optional
Enables or disables the song ratings system (!rating/!rate)
MaxRating			5
Optional
Changes the maximum rating a song can have (default & minimum: 5)
Note: It is not recommended to change this setting since not everything has been tested with a setting over 5.
EnableRequestSystem	1
Optional
This turns the request system on and off. (default: 1)
EnableFind		1
Optional
This turns the @find command on and off. (EnableRequestSystem must be 1 for @find to work) (default: 1)
MaxFindResults		10
Optional
This sets the maximum number of song results to return on an @find command (default: 10)
ExpireFindResults	15
Optional
Sets how long in minutes to keep find results cached for people to be able to use !request # instead of !request filename (default: 15)
AllowPMRequests	1
Optional
This controls whether the bot will accept !request's from PMs and consoles.
RequestFallback	#channel
RequestFallback	nick
Optional
Sets a channel or nick to send requests to if there is no Live DJ or source plugin active. If not set then the bot will use it's normal behavior of saying there is no DJ taking requests.
ReqModesOnLogin	o
ReqModesOnLogin	vh
Optional
Sets channel modes to set on a user when they use !reqlogin. Will set modes on all common channels that the bot and nick are on.
You can use more than one letter to set more than one mode (vh would set +v and +h). Default: empty/none
DefaultFlags		+q
Optional
Sets the default flags for a user without an user account (ie. Level 5 in RadioBot v1-4). By default unknown users only have +q (!request/@find) access.
For more information see User Flags.
Fork			1
Optional
This will make the bot fork into the background during startup. This is good for people who run the bot in SSH windows so they don't have to use nohup.
PullNameFromAnyServer	1
Optional
This controls whether the bot will try to get stream titles from any media server, or just the 1st media server. (default off)
AutoRegOnHello		1
Optional
This controls whether the bot will automatically create a user if someone types /msg botnick hello (default off)
SendQ			300
Optional
This controls the maximum bytes per second that will be sent to your IRC server(s). Default is 300 bps. If you find the bot is flooding off on your IRC server often, adjusting this may help.
MultiSoundServer	1
Optional
This will enable Multi Sound Server Mode where each of your sound servers will be reported independently. (Things like !request, triggers, etc. will still only operate on the 1st server)
BindIP			0.0.0.0
Optional
This sets the IP listening sockets will bind to. (Note: what IP outgoing connections bind to is unaffected except for IRC connections, which do bind to the IP)
LogChan			#testing
Optional
This sets a channel the bot will display certain log messages to.
LogChanKey			password
Optional
This sets the channel key for the log channel (if needed)
LogFile			ircbot.log
LogFile			ircbot_%plug%.log
Optional
This sets a filename the bot will log to. If there is no path separator (\ on Windows, / on Linux/BSD) in the filename it will put the log in the logs subfolder.
If you put %plug% in the filename there will be an individual log for the bot and each plugin instead of one large log.
TLS_Cert		ircbot.pem
Optional
This will enable TLS connections using the specified PEM file. Note: If you do not specify TLS_Cert and a valid PEM file, TLS will not be available in RadioBot.
PIDFile		/path/to/ircbot.pid
Optional
This will write the bot's PID to a file on startup (useful for automated scripts on Linux/etc.)
BackupDays		14
Optional
This controls how many days files will be left in the backup folder before being deleted. (default 14, set to 0 to disable automatic deletion)
Note: The file deletion scan is indiscriminate of filename or if the bot created it, it only checks the file modification time and deletes it if it is older than X days.
Do not place any file in the backup folder you don't mind being automatically deleted!
CommandPrefixes	!@?
Optional
This will let you define alternate or additional command prefixes. By default you can use !, @, or ? which would correspond with a setting of !@?.
RemotePort		10001
Optional
This sets what port RadioBot listens on for remote connections (bot client, WebRequest System, etc.). (default: 10001)
Set to 0 and the remote system will be disabled.
User accounts must have +r to connect to the remote port.


RadioBot vde

RadioBot main pages
Main PageInstallationChangelogCommandsPluginsFAQConfigurationCreditsRemote ClientBuilt-In VariablesMulti Sound Server ModeUsername Character Restrictions
Auto DJ Pages
Auto DJ Main PageWebRequest SystemSchedulerMP3 EncoderVoice SupportMySQL Plugin
Personal tools