An integration with SwiftIRC through the OSRS chat box.
This will share your IP with the SwiftIRC administration.
It is ideal to set the prefix to a character you can easily prefix IRC messages.
The default prefix is ;. This document will use the default as reference.
Channel messages will show up in the chat box starting with the username that sent the message.
Sending a channel message: ;words can go here
Example: ;Hello #rshelp!
Sending a private message: ;;msg <nick> <message>
Example: ;;msg foobar Thanks for the information
Sending a notice: ;;notice <nick> <message>
Example: ;;notice foobar Hey there!
The following services run on SwiftIRC: NickServ, ChanServ, BotServ, HostServ, and MemoServ.
You may communicate via the following commands with the respective service:
BotServ: ;;bs
ChanServ: ;;cs
HostServ: ;;hs
MemoServ: ;;ms
NickServ: ;;ns
NickServ Identification: ;;id
Clear the side panel: ;;clear
Change channel modes: ;;mode #rshelp -s
View the topic: ;;topic
Change user modes: ;;umode +R
Change the focused channel: ;;go rsh
USA or UK.
More details are available at SwiftIRC.net: https://swiftirc.net/info/
The username used to connect to SwiftIRC.
The password to identify with NickServ.
The channel you intend to join. Leaving this blank will default to #rshelp.
Defaults to ;. Prefixed to messages destined for IRC.
Only show the active channel messages in the OSRS chat box. The "active channel" is the active tab in the side panel.
Enable to preview image links by hovering your mouse over them. WARNING: this will make it easier to share your IP with an image host.
When a new tab opens, autofocus on it. This means sending/receiving a notice/message to a target, without an open tab, will change the active channel to this target.
Server notices will default to the System tab; you can optionally allow them to create their own tab.
Writes every IRC line sent and received to the RuneLite client log. Off by default. Turn it on only when you are chasing a connection problem, then turn it back off - it is noisy.
Credentials are stripped before anything is written, so the log is safe to attach to a bug report:
the SASL exchange, server passwords, NickServ and ChanServ commands that carry a password, and
channel keys (from JOIN, from MODE +k, and from the server's own reply when you join a keyed
channel). What remains is the protocol traffic itself.
Whether the side panel will appear.
Prefix messages with a timestamp in the format of [hour:minute:second].
Add a color to nicks appearing in the side panel.
Specifically where the side panel appears on the right, from top to bottom.
Auto-joining multiple channels is possible by comma separating them in the settings:
#rshelp,#swiftirc,#cooking
To run commands, it is recommended to use the System tab of the side panel.
Once there, it is possible to register your nick and email (where the email is primarily required to reset a lost password):
/ns register <password> <email>
You can now save the password in the settings for the plugin. This will automatically identify you when you connect.
Once you have registered your nick, you can join registered-only channels and register new channels.
These commands will create and register a new channel:
/join #secret-new-channel
/cs register #secret-new-channel
You can ask in #irchelp for IRC-specific questions.
/join #irchelp
The plugin reports why a connection failed rather than leaving you to guess. When something goes wrong you should see one of:
- A reason from the server.
Server closed the link: Closing Link: you[1.2.3.4] (Ping timeout: 240 seconds),Killed by <operator>: <reason>, orServer error 465: You are banned from this server. This is the server's own text - it is the most useful thing to include in a report. - A reason from the network.
DNS lookup failed: irc.swiftirc.net could not be resolved, orFailed while connecting to irc.swiftirc.net:6697 - ConnectException: Connection refused. The message names what was being attempted (connecting, the TLS handshake, registering, or reading from an established connection) so a firewall problem is distinguishable from a server problem. - A silent close.
Connection closed: server closed the connection during registration, without saying whyusually means the server dropped you without explanation - a ban or a connection throttle.
Disconnect messages carry the cause where one is known, so Disconnected from IRC (Ping timeout: 240 seconds) tells you it was not your own /quit.
If a problem is not reproducible, enable log raw IRC lines in the plugin settings and reproduce it. The full protocol exchange, with passwords removed, is written to the RuneLite client log. The setting takes effect immediately, so you can turn it on before reconnecting.