Customization parameters

You must pass at least one parameter to the SWF (host), the others are optional.
These parameters can be added or changed within the config.js (included in the lightIRC.zip package).

If you find a useful parameter for your application, just add it to your config.js. Assuming you would like to change the lightIRC design, you find the parameter styleURL here. This means you need to add params.styleURL = "some value"; to your config.js.
You can also append parameters to www.lightirc.com/start/, e.g. www.lightirc.com/start/?host=irc.lightirc.com&nick=lightIRC_test&autojoin=test

Example of what you can change with parameters. See many more parameters below.

If you have trouble putting your own config together, have a look at this invention of a lightIRC user, which facilitates configuration work.

Parameter Default Description
Connection
host Server IP/hostname
port 6667 Server port
policyPort 843 Defines the port where Flash Player should look for the policy daemon
General settings
charset utf-8 The encoding for incoming/outgoing messages. If you have trouble with utf-8, try the charset of your country (e.g. iso-8859-1)
nick lightIRC_% The username to connect with. It is also a prefilled value for the nickselect box. Add "%" and lightIRC inserts a random number to prevent doubles (e.g.: "%nick%" -> nick123")
nickAlternate Alternative nick. Gets used if "nick" is occupied.
rememberNickname false Stores a selected/changed nickname in a local cookie and uses it everytime the user comes back.
nickPrefix < Setting for a string which should be displayed in front of a nick in the chat area.
nickPostfix > Setting for a string which should be displayed behind of a nick in the chat area.
showNickPrefixes true Indicates whether a nick in the chat area is displayed like this: @nick or +nick.
showNickPrefixIcons false Whether user icons should be shown in the chat area
password Server password (only needed on very few servers)
ident Ident for the user. If you don't set a value, lightIRC sets a random string as the ident. This ident gets saved and will be used everytime the user comes back.
realname lightIRC.com Flash IRC Client Real name (GECOS) for the user
quitMessage lightIRC.com Flash IRC Client Quit message for the user
Please note that the quit message gets only sent if the user types /quit in the chat. If he closes the lightIRC window, the server defines the quit message (connection reset by peer, ping timeout, ...)
language en Language for the user interface. Currently available translations: ar Arabic Syrian, bd Bengali, bg Bulgarian, br Brazilian Portuguese, cz Czech, da Danish, de German, el Greek, en English, es Spanish, et Estonian, fi Finnish, fr French, hu Hungarian, hr Croatian, id Indonesian, it Italian, ja Japanese, lv Latvian, nl Dutch, pl Polish, pt Portuguese, ro Romanian, ru Russian, sk Slovak, sl Slovenian, sq Albanian, sr_cyr Serbian Cyrillic, sr_lat Serbian Latin, sv Swedish, th Thai, tr Turkish, uk Ukrainian
languagePath language/ Where to look for the lightIRC translation files.
emoticonPath emoticons/ Relative or absolute path to the emoticons folder.
iconPath icons/ Relative or absolute path to the icons folder (if useUserListIcons is enabled).
enableQueries true Set this to false to remove support to start queries, that is double clicking a user name and selecting the query from the context menu will not work. However, the user is still able to receive queries or to write private messages with /q, /query or /msg.
autojoin Comma-separated list of channels to join after a connection is established.
E.g.: #lightIRC,#help
perform Comma-separated list of commands to be executed after connecting. E.g.: /mode $me +x,/join #channel key
$me and %nick% get replaced by the current nick. %pass% gets replaced by the entered identifyPassword or the correspondent parameter.
blockedCommands Comma-separated list of commands which cannot be entered by the user. If you set it to "nick,j,join", the user cannot change the nick and is not able to join channels. However, he can still use the lightIRC popups to change his nick or join from the channels list. (You can hide those popups separately)
loopServerCommands false This is an advanced setting. If you set it to true, all messages from the IRC server are sent to the JavaScript method onServerCommand(command) (see config.js) before lightIRC processes them. lightIRC uses the return value from that method. You can check the server response for specific events and build your own system behind lightIRC in JavaScript. If you return null or an empty string from the function, lightIRC won't notice that new data from the server has been received.
loopClientCommands false This is an advanced setting. If you set it to true, all outgoing messages from lightIRC are sent to the JavaScript method onClientCommand(command) (see config.js) before they get sent to the IRC server. lightIRC uses the return value from that method to send a command to the IRCd. If you return null or an empty string from the function, nothing gets sent to the IRC server.
autoReconnect true Reconnect if the connection to the server gets interrupted. You typically don't want to change this setting.
showSecurityError true Hides the security error message when set to false. You typically don't want to change this setting. The security error tells you that the policy daemon is not running or your policyPort setting is not correct.
customSecurityErrorMessage You can set a custom security error message instead of the default one
targetFrame _blank Lets you specify the target frame for clicked URLs in the chat area
defaultBanmask ∗!%ident%@∗ Default banmask for the ban popup. %nick%, %ident% and %host% get replaced automatically.
performContinousWhoRequests false Whether lightIRC should perform a WHO request for every user in a channel. This is necessary if you want to use ident, realname or host of your users for userListCustomFormatting or a JavaScript method like onContextMenuSelect or onChatAreaClick. Please note that this setting can cause performance issues when used in large channels (> 100 users)
Webcam
webcam false Enables the webcam module using a streaming server backend. The module must be purchased. More information
rtmp IP/host of the Red5/Wowza streaming server
webcamPreviewBox true If the webcam controls should appear as a small box above the user list
webcamPrivateOnly false If users can only broadcast in private mode (not public)
webcamPublicOnly false If users can only broadcast in public mode (not private)
webcamVideoOnly false If users can only broadcast their cameras (no audio)
webcamAudioOnly false If users can only broadcast their microphones (no video)
webcamChannelBlacklist Comma-separated list of channels where the webcam module does not work (icons don't show up in the user list)
webcamChannelWhitelist Comma-separated list of channels where you want the webcam module to work. If you set something here, the webcam module won't work in all other channels! If you wan't to restrict the webcam usage, you should use either the blacklist or the whitelist setting.
Appearance
styleURL A relative or absolute URL to a lightIRC CSS file.
navigationPosition bottom Position of the navigation container (where channel and query buttons appear). Valid values: left, right, top, bottom
showNavigation true Hides the navigation container when set to false. You are not able to switch between channels and queries then.
Nickname identification
identifyPassword Identifies the user to NickServ with the given password. Sends the value of identifyCommand to the server. This parameter is not that useful. You should rather set appropriate values for identifyMessage and identifyCommand to let the user identify himself inside of lightIRC.
identifyMessage NickServ:This nickname is registered The default value means lightIRC searches the string "This nickname is registered" within all notices from NickServ. If it finds that message, a window to enter a password pops up.
identifyCommand /msg NickServ identify %pass% This is the services command lightIRC sends when a user submits the identify popup. %nick% and %pass% get replaced automatically.
Nickname registration
showRegisterNicknameButton false Shows a button to register a nickname.
registerNicknameServiceName NickServ Set this to the NickServ equivalent of your server. Responses of this service get parsed and are shown inside of the register nickname popup.
registerNicknameCommand /msg NickServ register %password% %mail% lightIRC sends this command when the user hits the submit button of the register nickname window. %password% and %mail% get replaced by the entered values. %nick% gets replaced by the current nick.
Channel registration
showRegisterChannelButton false Shows a button to register a channel.
registerChannelServiceName ChanServ Set this to the ChanServ equivalent of your server. Responses of this service get parsed and are shown inside of the register channel popup.
registerChannelCommand /msg ChanServ register %channel% %password% %description% lightIRC sends this command when the user hits the submit button of the register channel window. %channel%, %password% and %description% get replaced by the entered values.
Client settings (changeable in the user options window)
soundAlerts true Indicates whether a sounds are on (they are played on highlight or on new private message).
showTimestamps true Show a timestamp in front of all received messages and commands.
timestampFormat [HH:mm:ss] Sets the timestamp format. For all valid patterns please see the DateTimeFormatter documentation.
showJoinPartMessages true Show join, part and quit messages.
showNewQueriesInBackground false Opens new queries in background when set to true. When keeping the default mode, a new query window gains focus upon receiving a private message.
fontSize 12 How large should fonts in text input and chat area be displayed?
Windows
showServerWindow true Whether the server window (and button) should be shown. If you set the value to false, a popup appears when you start lightIRC. It contains a connecting message and stays open until the connection to the IRC server is established.
showNickSelection false Indicates whether a popup to enter a nickname should be displayed before connecting.
showIdentifySelection false Adds a password field to the nick selection box. Identifies the user to a nickname service. Uses the identifyCommand value.
showServerPasswordSelection false Indicates whether a popup to enter a server password should be shown before connecting.
showChannelCentral true You can open the channel central in three ways. By clicking the button in the menu (showListButton), selecting the item in the channel button context menu or double-clicking the channel window. This parameter can disable the latter.
Menu buttons
showMenuButton true Shows the menu button. The menu gets disabled if you set this value to false. You don't need to disable the following menu buttons then.
showListButton true Shows button to list all channels on the network.
showNickChangeButton true Shows button to change the nickname.
showOptionsButton true Shows the options button to adjust different settings.
showChannelCentralButton true The channel central gives users the possibility to manage channel modes, bans and the topic.
showJoinChannelButton true Shows a button to join a channel.
showPartChannelButton true Shows the part/leave channel button.
showRegisterChannelButton false Shows a button to register a channel.
showRegisterNicknameButton false Shows a button to register a nickname.
Sounds
soundAlerts true Indicates whether a sounds are on (they are played on highlight or on new private message).
soundOnNewChannelMessage false Indicates whether a sound should be played when a new channel message is received.
Emoticons
showEmoticonsButton true Shows a button to select an emoticon.
emoticonPath emoticons/ Relative or absolute path to the emoticons folder.
emoticonList :)->smile.gif,;)->wink.gif,:D->biggrin.gif,:P->tongue.gif,:(->sad.gif,:$->blushing.gif,:O->ohmy.gif,(H)->cool.gif,:|->mellow.gif,Oo->blink.gif,:'(->crying.gif,:S->unsure.gif,:[->mad.gif List of emoticons in the following format: code->file,code->file
You can add more emoticons by adjusting this parameter. The emoticons will be displayed in the emoticon select popup as well. If you want to disable the emoticons, pass an empty string as the value.
Text input area
showRichTextControls true Shows buttons for text formatting (bold, underline, color)
showRichTextControlsForegroundColor true Shows foreground color selection in the rich text control popup
showRichTextControlsBackgroundColor true Shows background color selection in the rich text control popup
showEmoticonsButton true Shows a button to select an emoticon.
showSubmitButton true Shows a button to submit a message. Even if you can submit a message by pressing enter, a chat novice would prefer to have a button to click.
Channel settings
showChannelHeader true Indicates whether the channel header should be shown. This is the place where channel name and topic appear (by default above the chat area and user list).
channelHeader %channel% [%users%] [%mode%] %topic% Adjust this message to have a custom format for the channel header. %channel%, %users%, %mode% and %topic% get replaced automatically.
E.g.: You are now talking in %channel% with %users%. The mode is: %mode%. The topic is: %topic%
showInfoMessages true Setting this value to false hides all messages that are no real messages and no join, part or quit messages from channels and queries. That includes mode changes, nick changes, topic, ignores, kicks and so on.
showVerboseUserInformation false Adds ident and host information for joins, parts and quits.
User list
userListWidth 150 Any value >= 100 or 0 (hides the user list).
useUserListIcons false Show icons in the user list instead of user prefixes (like @%+)
userListCustomIcons This is an advanced setting. You can define an URL to a script, which outputs an image (not only the URL to an image!). If you pass a value like http://www.lightirc.com/?getImage=%nick%&prefix=%prefix%, lightIRC will show this image in the user list next to the specific user name. You should make sure that the image has correct dimensions (like 20x20px) and that your script always points to working images. %prefix% is being replaced by q/a/o/h/v or an empty string. You can also use %ident% and %realname% in the image URL.
userListCustomFormatting Syntax: (nick/ident/host/realname/mode)=(regular expression):(style name)
You separate multiple settings with commas. Please set performContinousWhoRequests to true if you want to use ident/host/realname in the regular expression. Fore more in-depth information see this wiki article.
showUserListInformationPopup false Show a popup with user information when hovering a user in the user list
userListInformationPopupItems nick,ident,realname,host Items to include in the popup. If you want to use ident, realname or host, you need to set performContinousWhoRequests = true. The default setting describes all possible values.
User list context menu
contextMenuInternalEvent Set a value to add a new item to the context menu.
Syntax: Name of the item:command to send
E.g.: Kick a user with default error message:/kick %nick% %channel% Kick!
%nick% and %channel% get replaced automatically.
contextMenuExternalEvent Set a value to add new items with the given names to the context menu (e.g.: Open profile,Send mail). The JavaScript method onContextMenuSelect(type, nick) (see config.js) gets called when the context menu item is selected. The type value includes the selected item (e.g.: Open Profile). As an example, you could open up a new window in your JavaScript code pointing the user to a profile.

parameters.png (38.4 KB) Valentin Manthei, 12/19/2010 11:43 am