You are here: Home > Chat > Lightparams
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
|!parameters.png!|
Example of what you can change with parameters. See many more parameters below.
| 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 | ||
| 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. |
| password | 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: bd Bengali, bg Bulgarian, da Danish, de German, el Greek, en English, es Spanish, et Estonian, fr French, it Italian, ja Japanese, nl Dutch, br Brazilian Portuguese, ro Romanian, ru Russian, 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. |
| 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-seperated list of channels to join after a connection is established. E.g.: #lightIRC,#help |
|
| perform | Comma-seperated 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. |
|
| 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. |
| Webcam | ||
| webcam | false | Enables the webcam module using a Red5 backend. The module must be purchased. |
| rtmp | IP/URL of the Red5 streaming server | |
| 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. |
| 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 | true | 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) |
| showEmoticonsButton | true | Shows a button to select an emoticon. |
| showTranslationButton | true | Shows a button for automated message translation |
| 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. |
| 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 @%+) |
| 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 a new item with the given name to the context menu. The JavaScript method onContextMenuSelect(nick) gets called when the context menu item is selected. As an example, you could open up a new window in your JavaScript code pointing the user to a profile. | |