| Both sides previous revisionPrevious revisionNext revision | Previous revision |
| jabber [2013/10/28 03:29] – Removed google talk references ch1b1 | jabber [2013/10/31 04:14] (current) – ch1b1 |
|---|
| ====== Jabber Bot ====== | #REDIRECT xmpp |
| <WRAP important> | |
| 20 May 2013: Google is dropping support for **XMPP** from its new Hangouts product. This will cause the bot to cease functioning for Google users. See the "[[jabber#google_hangouts|Hangouts]]" section below for details. | |
| </WRAP> | |
| | |
| {{ :avatar:xmpp_logo.png?nolink|Jabber/XMPP}} Have you ever wanted to know how many people are connected to the Minecraft server... without having to open Minecraft? With the Jabber Instant Messenger bot, now you can. To see near-real time information about the server status, just add **[[xmpp>status@theparadox.us|status@theparadox.us]]** to your instant messenger contacts. You can even register to be notified when a certain number of players connect. This way, you can wait around for your friends... without waiting around for your friends. Instant Messaging enables the smart and rapid delivery of these notifications to a variety of devices. | |
| | |
| ===== Getting Connected ===== | |
| Anyone with a Jabber ID can use the Minecraft bot. To get started, sign up for an XMPP account with any server in the [[http://xmpp.net/|XMPP federation]]. These servers are free-to-use, and you can use any of them that you like. Once you sign up, add [[xmpp>status@theparadox.us|status@theparadox.us]] to your contact list. | |
| | |
| You will need one of the following types of client software to get connected. | |
| | |
| ==== Desktop Clients ==== | |
| Virtually any multi-protocol instant messenger client supports Jabber. You can use [[http://pidgin.im/|Pidgin]] for Windows or Linux, [[https://live.gnome.org/Empathy/|Empathy]] for linux, or [[http://adium.im|Adium]] for Mac. | |
| | |
| ==== Mobile Devices ==== | |
| On Android, use an XMPP client such as [[http://www.xabber.com/|xabber]] or [[http://beem-project.com/|BEEM]]. Support for instant messaging on iOS is less than stellar. Jabber clients, such as Monal, can run as background tasks on the 3GS and above. | |
| | |
| ==== Web Clients ==== | |
| A variety of XMPP servers, such as [[http://tigase.me/|tigase.me]], offer web-based instant messengers. These should work just fine. | |
| | |
| ==== Google "Hangouts" ==== | |
| As of 20 May 2013, Google's latest chat product, "Hangouts," does not support the XMPP protocol and has no open API. This applies to both the Chrome and the Android versions of Hangouts. Since it is no longer possible to send or receive messages to Hangouts users by any automated means, the bot cannot support it. Please see [[http://windowspbx.blogspot.de/2013/05/hangouts-wont-hangout-with-other.html|this article]] for details and make your [[http://productforums.google.com/forum/#!topic/chat/Yvaa70u-AOI|opinion known]] on the Google Product Forums. | |
| | |
| We are in the process of exploring alternative solutions. In the meanwhile, we invite you to use a third party XMPP service for all your IM needs. | |
| | |
| ===== Using the Bot ===== | |
| The bot broadcasts the number of players on the server, and the server's Message of the Day, in its status message. Normally, the bot's status is always "available," but if the server is down, the bot will change its status to "Do Not Disturb/Busy." The bot is well-behaved and will never send you any messages unless you ask it to do so. You can interact with the bot by sending it one of the following commands: | |
| | |
| ^ Summary of Commands ^^^ | |
| ^ Command^ Shortcut ^Meaning ^ | |
| | ''help [command]''| ''h'' |Get help about a given command | | |
| | ''status''| ''s'' |Display server and notification status | | |
| | ''notify [min_players] [HHhMMm] [away] [private]''| ''n'' |Add a notification | | |
| | ''notify-increase [HHhMMm] [away] [private]''| ''ni'' |Add a recurring smart notification | | |
| | ''stop''| ''c'' |Cancel any active notifications | | |
| | |
| The shortcuts are equivalent commands---''c'' is a synonym for ''stop''. This makes using the bot from your smartphone much easier. | |
| | |
| ==== Adding a Notification ==== | |
| You can ask the bot to notify you when players connect to the server. You might want to do this if | |
| * You like playing Minecraft with friends | |
| * You're idling and want to know if someone else signs on | |
| * The server is down, and you want to know when it comes back up | |
| | |
| To add a new notification, type: | |
| | |
| ''notify [min_players] [HHhMMm] [away] [private]'' | |
| | |
| The bot will send you an alert if at least ''min_players'' are logged into the Minecraft server within the next ''HH'' hours and ''MM'' minutes. The default expiration time is two hours from now. By default, you will only receive notifications if at least one of your IM clients has a status of ''available.'' If you are ''away,'' notifications will be delivered when you return, provided they still apply. To receive notifications even while you're away, use the ''away'' argument. The number of players with active notifications is listed in the bot's presence message---this gives everyone an idea of how interested people are in Minecraft. To exclude yourself from this count, use ''private.'' | |
| | |
| The basic notification only triggers once, but you can also request a smart notification which can trigger multiple times: | |
| | |
| ''notify-increase [HHhMMm] [HHhMMm] [HHhMMm] [away] [private] [once]'' | |
| | |
| The smart notification will let you know whenever the number of players on the server increases. The first parameter is the expiration time; notifications will continue until the time has elapsed. The second parameter is a cooldown period. Once a notification sends, the cooldown period must pass before another one can be sent. This prevents the bot from annoying you with repeated notifications. The third parameter is the depart-rejoin delay. This delay prevents players who disconnect and rapidly reconnect from triggering a notification. When the player count decreases, the count must remain low for the depart-rejoin delay before it is considered accurate. The default cooldown period is five minutes, and the default depart-rejoin delay is two minutes. The ''once'' flag will cause the notification to only trigger once. | |
| | |
| Example invocations include: | |
| * ''notify'': The default notification is one more person than is presently playing for the next two hours. | |
| * ''n 1 1h30m'': Look for any connected players within the next ninety minutes. The ''n'' is a short-cut for ''notify.'' | |
| * ''notify-increase 8h away private'': For the next eight hours, you will be notified when the number of players on the server increases, even if you are listed as away, without listing yourself as "looking for group." This is perfect for idling. | |
| * ''notify 0 24h'': If the server is down, notifications for zero players will be accepted and sent when it comes back up. | |
| | |
| You may only have one notification at a time. Adding a new notification will replace your existing one. | |
| | |
| ==== Canceling a Notification ==== | |
| All notifications expire within twenty-four hours. Normal ''notify'' requests will only trigger once, but ''notify-increase'' requests will keep sending you messages until the request expires. To cancel either type of notification before it expires, send the **''stop''** command. | |
