OGN ZNC

From OnlineGamesNetWiki
Jump to: navigation, search

This page has been created to provide basic information about bouncer service - exactly ZNC, which is provided by OnlineGamesNet to the members of the Gameforge teams. This guidelines may fit to other ZNC providers, but not in all cases.

If you are searching for a more concise guide, take a look at OGN ZNC start, which covers the very basics of requesting and starting to use a OGN ZNC bouncer.

What is ZNC?

ZNC is advanced bouncer, that is left connected so an IRC client can disconnect/reconnect without losing the chat session. It has various settings, which allow you to log messages, queries and many other things.

Requesting ZNC and support

If you are a teamler of a Gameforge community and you are interested in our ZNC, you may request one by means of the request tool or the IRC channel #OGN-BNC, where you need to submit a ticket using the command /obs <Your problem>.

We advice using mIRC because our commands are designed for this client.

Should you have general questions, you can try to ask them in #OGN-BNC and, if noone helps you, you can also submit a ticket.

ZNC commands and settings

Not all commands are listed!

ZNC servers and Webinterface

Here you can find webinterface for each server of our ZNCs. Check your server settings (or ask BNC staff), to see which one are you using:

Server Port SSL Port Webinterface
1 33333 43333 http://bouncer.onlinegamesnet.net:33333/
2 33334 43334 http://bouncer.onlinegamesnet.net:33334/
3 33335 43335 http://bouncer.onlinegamesnet.net:33335/
4 - - Due to technical reasons skipped
5 33337 43337 http://bouncer.onlinegamesnet.net:33337/
6 33338 43338 http://bouncer.onlinegamesnet.net:33338/

Default modules and available settings

  • status
    • You may set some general settings via *status and it allows you to list some informations. All /msg *status commands may be replaced with /znc, if you use mIRC.
      • /msg *status Help - List all commands used with *status, however you can't use all of them.
      • /msg *status Version - Print the current ZNC version.
      • /msg *status ListChans - List all channels, you are in.
      • /msg *status ListNicks <#chan> - List all nicks on provided channel.
      • /msg *status ListClients - List all clients connected to your ZNC user
      • /msg *status ListServers - List all servers
      • /msg *status Detach <#chan> - Detache chan (You will be in channel, but you won't receive messages from it anymore and won't see it at all), in mIRC can be used /detach #chan too. Detaching may be canceled via /join #chan. Take a look at autoattach module too!
      • /msg *status Topics - Show topics in all your channels
      • /msg *status PlayBuffer <#chan> - Play back the buffer for a given channel
      • /msg *status ClearBuffer <#chan> - Clear the buffer for a given channel
      • /msg *status ClearAllChannelBuffers - Clear the channel buffers
      • /msg *status SetBuffer <#chan> [linecount] - Set the buffer count for one or more channels. That means how many lines you will receive from given chan, after you connect. [linecount] is a number from 0 to 2000 (lines). Wildcards are accepted, so you may change all buffers at once by typing /msg *status SetBuffer * [linecount].
      • /msg *status Jump - Reconnects you to IRC.
      • /msg *status Disconnect - Disconnect from IRC
      • /msg *status Connect - Reconnects you to IRC.
      • /msg *status Uptime - Show for how long ZNC has been running.
      • /msg *status ShowMOTD - Show ZNC's message of the day
  • Usermod
    • Here you can set vacation, realname and LoC
      • /msg *usermod set realname <your realname> - Change your realname
      • /msg *usermod set vacation on/off - Turn on/off your vacation mode - turn it on, if you know you won't connect to your ZNC for more than 2/3 weeks to prevent it being deleted due to inactivity (will be done after a month of inactivity).
      • /msg *usermod set loc <AuthName>:<AuthPass> - Set LoC, which allows you to get team privileges, like increased number of chans etc. Example: /msg *usermod set loc User:HisPsw
  • simple_away
    • Automatically set you away on IRC when disconnected from the bouncer.
      • /msg *simple_away help - Shows help for simple_away with commands.
      • /msg *simple_away Reason [<text>] - Prints and optionally sets the away reason.
      • /msg *simple_away Timer - Prints the current time to wait before setting you away.
      • /msg *simple_away SetTimer - Sets the time to wait before setting you away (in seconds).
      • /msg *simple_away DisableTimer - Disables the wait time before setting you away.
  • perform
    • Performs commands on connect.
      • /msg *perform help - List all commands
      • /msg *perform add <command> - Adds a command. You may use %nick% as your current nick. This way you can perform setting of some user modes etc. Example: /msg *perform add mode %nick% +xinIt.
      • /msg *perform list - List current performs
      • /msg *perform del <nr> - Deletes one perform command - they are numbered in /msg *perform list.
      • /msg *perform execute - Run all perform commands.
      • /msg *perform swap <nr> <nr> - Swap order of current perform commands.
  • autocycle
    • Cycles a channel when you are the only one in there and you don't have op.
      • It's defaultly set to all chans you are in, but you can do /msg *autocycle del * and /msg *autocycle add <#chan> to add just some channels. Wildcards are allowed.
  • buffextras
    • Add nick changes, joins, parts, topic changes etc. to your playback buffer.
      • Has no settings. May be unloaded by BNC staff.
  • kickrejoin
    • Implements auto-rejoin-on-kick.
      • /msg *kickrejoin setdelay <sec> - Set delay, before you rejoin channel.
      • /msg *kickrejoin showdelay - Show current delay.

Other loadable modules

These modes are not loaded by default. You may ask OGN BNC staff for loading them, if you are interested in them. You can display help for each module (if the module is settable) via /msg *module help.

  • autoattach
    • Autoattach watches your detached channels and reattaches you automatically when there is activity in a channel you added to your autoattach list. Read about detaching in *status part of this article to learn about detaching.
      • /msg *autoattach Add - Add an entry, use !#chan to negate and * for wildcards.
      • /msg *autoattach Del - Remove an entry, needs to be an exact match.
      • /msg *autoattach List - List all entries.
  • autojoin
    • Auto-joins a channel when someone invites you provided that some conditions are fulfilled.
      • /msg *autojoin AddUser <user> <hostmask> <channel> [channel, ...] - Adds a user to autojoin's list. If someone matching the hostmask invites you to one of these channels, you will join it. user can be anything you want: it's just a word which identifies a person or a group of people. Wildcards are allowed for the hostmask and channels. Examples:
        • /msg *autojoin AddUser all * * - Accepts invitations from everybody to everywhere.
        • /msg *autojoin AddUser teamlers * *-team #help - Accepts invitations from everybody to channels containing -team and also to channel #help.
        • /msg *autojoin AddUser ChanServ ChanServ@Services.OnlineGamesNet.net * - Accepts invitations from ChanServ to everywhere.
      • /msg *autojoin DelUser <user> - Deletes a user from autojoin's list.
      • /msg *autojoin Listusers - Shows all added users together with their hostmask and channels.
      • /msg *autojoin AddChans <user> <channel> [channel, ...] - Adds a channel (or more than one) for an existing user. Wildcards are allowed.
      • /msg *autojoin DelChans <user> <channel> [channel, ...] - Deletes a channel (or more than one) from an existing user.
    • Note: this module will be available after next update of OGN ZNC bouncers.
  • autoop
    • This module is meant to auto op users that you have added to your personal list. It attempts to do so using CRAM-MD5 to increase security, but you should always use with caution. The secure version of adding is possible only for users, who use ZNC too and is very avanced to set. I will mention only the non-secure one. But in case you use it in OGN and will use it with fakehosts only, it's quite secure too.
      • /msg *autoop AddUser <user> <hostmask> __NOKEY__ [channels] - Add a user in your autoop list. You need to provide mask for that user in form nickname!ident@host (for example *!*@xxx.user.OnlineGamesNet - for user with OGN account "xxx" and all his nicks and idents). Channels are the channels you want that user gain OP. Wildcards are allowed. __NOKEY__ should be kept in this form, if you want to use autoop with key for other ZNCs, ask BNC staff how to set it or search it on your own.
      • /msg *autoop List - List all entries with users and chans.
      • /msg *autoop DelUser <user> - Delete a user from autoop list.
      • /msg *autoop AddChans <user> <channel> [channel] - Add a channel for existing user.
      • /msg *autoop DelChans <user> <channel> [channel] - Delete a channel from existing user.
  • autoreply
    • This module automatically answers to queries if you are not connected to ZNC.
      • /msg *autoreply Set <reply> - Sets a new reply
      • /msg *autoreply Show - Displays the current query reply
  • autovoice
    • This module voices everyone joining the channel you tell it to.
      • /msg *autovoice AddUser <user> <hostmask> [channels] - Add a user in your autovoice list. You need to provide mask for that user in form nickname!ident@host (for example *!*@xxx.user.OnlineGamesNet - for user with OGN account "xxx" and all his nicks and idents). Channels are the channels you want that user gain voice. Wildcards are allowed. Example: /msg *autovoice AddUser * * #channel - Everybody who joins #channel gains voice.
      • /msg *autovoice List - List all entries with users and chans.
      • /msg *autovoice DelUser <user> - Delete a user from autovoice list.
      • /msg *autovoice AddChans <user> <channel> [channel] - Add a channel for existing user.
      • /msg *autovoice DelChans <user> <channel> [channel] - Delete a channel from existing user.
  • block_motd
    • Block the MOTD from IRC so it's not sent to your client(s). Has no settings.
  • charset
    • Normalizes (i.e. converts) character encodings.Has no user settings, the only settings may be done by BNC staff
  • Clearbufferonmsg
    • This module attempts to bridge the gap between being inundated with old buffer if you have KeepBuffer=true; and possibly missing messages when you ping out, if you have KeepBuffer=false.
    • What the module does is clear the buffers when it sees a user-originated message come in, indicating that the user is alive and connected. Used in combination with KeepBuffer=true setting, you minimize old buffer spam, while solving the problem of possibly missing buffer upon connection timeout. Has no settings
  • clientnotify
    • Notify about new incoming connections to your user. Has no settings
  • crypt
    • This module was designed to be compatible with mircryption's CBC mode. It encrypts the conversion on channels or queries.
      • /msg *crypt SetKey <#chan|Nick> <Key> - Set an encryption key. From then on, all messages to that target will be encrypted. Received messages are automatically decrypted.
      • /msg *crypt DelKey <#chan|Nick> - Delete an existing key.
      • /msg *crypt ListKeys - List all keys.
  • ctcpflood
    • This module tries to block ctcp floods. Has no settings
  • disconkick
    • This module will kick your client from all channels where you are, in case if ZNC disconnects from server. There are no tunable settings.
  • fakeonline
    • This module fakes the online status of ZNC-*users, so that ISON and WHOIS commands to *status e.g. return something that makes the IRC client believe the user is online. This helps to query with these users for specific IRC clients like Colloquy that perform online check of open query windows.
  • flooddetach
    • This module detaches you from channels which are flooded. Has no settings
  • keepnick
    • This module tries to get you your primary nick. It should work on itself. However, you can enable and disable this module explicitly.
      • /msg *keepnick enable - Module will regularly try to acquire your primary nick.
      • /msg *keepnick disable - Module stops acquiring primary nick.
      • /msg *keepnick state - Tells you if the module is currently trying to change your nick to your primary nick.
  • leavechans
    • Automaticaly leave chans and inform users on disconnect. It sends the specified alert in the specified channel if you are present on it.
      • /msg *leavechans About - Prints the basic info about the module
      • /msg *leavechans Add <#support-channel> <#alert-channel> <message to print in the alert channel on disconnect while being in the support channel> - Adds a new channel to leave on disconnect
      • /msg *leavechans Delete <#channel> - Deletes a channel to leave on disconnect
      • /msg *leavechans List -
  • notes
    • This modules stores and displays short notes using a key/note pairs and shows them to you on connect. Notes are also accesible via the WebModules interface.
      • /msg *notes Add <Key> <Note> - Add a new note.
      • /msg *notes Del <Key> - Delete an existing note.
      • /msg *notes Mod <Key> <Note> - Modify an existing note.
  • raw
    • When this module is loaded the *raw user will print anything that happens on the server like in the following example:
<*raw> IRC -> [:flederohr!chatzilla@moz-1611319.dip0.t-ipconnect.de JOIN :#firefox]
<*raw> IRC -> [:firebot!firebot@moz-8BCFA482.carolina.res.rr.com PRIVMSG #firefox :welcome!]
<*raw> IRC -> [:Beebs!chatzilla@moz-8A98A72C.dsl.vic.optusnet.com.au PART #firefox :]
<*raw> YOU -> [privmsg #firefox :hm]
<*raw> IRC -> [:YaH!chatzilla@CBBA83DF.DB9F27F7.34E5CF41.IP QUIT :Ping timeout]
    • Has no settings
  • route_replies
    • If you connect to one ZNC user with multiple clients, you may see a lot of useless stuff like /who replies. This module fixes this by sending those replies only to the client who requested them and not to all clients.
      • /msg *route_replies silent [yes/no] - Enable/disable timeout messages
      • /msg *route_replies silent - Check if timeout messages are enabled or disabled
  • savebuff
    • This module saves your channel buffers into an encrypted file so they can survive restarts and reboots. Has no settings
  • schat
    • This module allows you to have a secure DCC chat with someone else who uses this module as well.
    • Once a chat is initiated you can chat with the other person via a query that looks like (s)<nick>.
      • /msg *schat chat <nick> - Requests secure chat with <nick>. That user needs to use ZNC with *schat module loaded too. /schat nick is another avilable command.
      • /msg *schat list - List all initiated chats.
      • /msg *schat close <nick> - Close a chat.
      • /msg *schat timers - Show related timers.
  • stickychan
    • This module can stick you to a channel, so that if you acidentally click it away it will simply come back.
    • If you /part the channel in your client, ZNC will intercept it and prevent it from being sent to the IRC server. Your client will immediately rejoin the channel.
    • If you are sapart'd or svspart'd from a stuck channel, you are automatically rejoined.
      • /msg *stickychan stick #chan <password> - Stick you to channel (with password).
      • /msg *stickychan unstick #chan - Unstick you from channel.
  • watch
    • This module allows you to monitor the activity of a specific user and/or text patterns and puts the sent text in a special query window. This might come in handy for you if, for example, you want to notice any message containing your nickname.
      • /msg *watch Add <HostMask> [Target] [Pattern] - Adds an entry to watch for. HostMask is the hostmask of the watched object -wildcards are allowed-, Target will be the name of the query window where you'll see the results of a given watch and Pattern lets you focus only on certain lines, which match that pattern. For example, *%nick%* may be used as a pattern if you want to known when does someone mention your nickname.
      • /msg *watch SetSources <Id> - Set the channels that you care about. Wildcards are allowed.
      • /msg *watch List - List all entries being watched.
      • /msg *watch Del <Id> - Deletes Id from the list of watched entries.
      • /msg *watch Clear <Id> - Deletes all entries.
      • /msg *watch Disable <Id | *> - Disables an entry without deleting it.
      • /msg *watch Enable <Id | *> - Enables a disabled entry.
      • /msg *watch Buffer [Count] - Shows/Sets the amount of buffered lines while being detached of a channel.
      • /msg *watch Dump - List all entries, including disabled ones.