Requirements

Instructions for installing PyRook and its dependencies for specific operating systems are included below. PyRook is cross-platform, and the general requirements are Python 3.3 or greater, PyQt4 or PyQt5, and lxml. pyenchant or hunspell-cffi are optional and provide spellcheck support.

Windows/OS X

The recommended installation method for Windows and OS X is Anaconda. If you don't use Python otherwise, install Miniconda's Python 3.x 64-bit version. If prompted, you want to make this your default version of Python and add it to your PATH.

On Windows, you can then use this script to install PyRook. You may get security warnings - I promise it's safe! If the script throws an error that 'conda' can't be found, you need to start it from the command prompt. Open your downloads folder, hold shift, right click, and choose "open command window here". Then type install-pyrook . Either way, say yes if prompted.

When the script is done, PyRook should open. It will be added to your start menu, and you can pin it to the taskbar from there if you wish. (Pinning the running app doesn't always work properly.)

Alternatively, to install manually, do the following: Open a command prompt (on Windows, open start menu -> type cmd; on OS X find Terminal in Applications) and run the following command to install PyRook's dependencies:

conda install pip setuptools pyqt5 lxml cffi pywin32

(Don't include pywin32 on OS X.) Say yes at any prompts. Once that has completed you can install PyRook itself and the spellchecker:

pip install pyrook hunspell-cffi

Note that hunspell-cffi is not currently available for every OS; if installing it fails PyRook itself will still work.

Finally, start PyRook:

pyrook

Linux

All required packages should be available from your distribution's package manager. On *ubuntu, install python3-pip python3-pyqt5 python3-pyqt5.qtwebkit python3-lxml python3-enchant. All other dependencies will be pulled in automatically if necessary.

You can then simply pip3 install pyrook and run pyrook to start. A desktop file will be installed into your application menu.

Versions

v0.1 Initial Release

First Qt based release. Should implement all basic functions, and most functions from the old wxWidgets based version.
  • v0.1.1: Lots of minor fixes: /purge, quit keyboard shortcut on Windows, open external links, sending messages with non-ASCII characters, more reliable chatstream merging, more reliable scrolling down on new message.
  • v0.1.2: More fixes: smileys, extraneous comma in some room names, purging, XML syntax error handling. Crash prevention when displaying room list and room with bots and no topic visible (though user list still isn't displayed in this case). Possible fix for intermittent crash on user list load.
  • v0.1.3: Features: highfive command, glow on input box when /msg targets selected. Fixes: URL handling (internal links, external links with special characters, links on PySide v1.0.3), userlist request crash (probably - please report if you still get it), parsing improvements, sane application exiting (individual rooms can be left, doesn't halt system shutdown, etc), room list window topic wrapping, misc cleanup.

v0.2

Changes since v0.1.3 include a better room join dialogue which will display any combination of users, topic and bots and has new room buttons; window alerts (taskbar highlight etc) on new messages or messages mentioning particular words; a permanent fix for chatstream merging and timestamp related bugs; and lots of miscellaneous fixes and tweaks.
  • v0.2.1: Configurable font size, improvements to highlighting handling, RookChat options, memos, help etc in menus, and fixes to room join dialogue for non-English languages.
  • v0.2.2: Remember username/password, command line options for user/pass/server, embedded QtWebKit tabs for internal RookChat links, logo/window icon, an internal debug log window, and more tweaks and fixes.
  • v0.2.3: Tweaks: skip the login box if a username and password are remembered, and allow remembering the size of the room join dialogue.
  • v0.2.4: Tweaks: Fix external links from web tabs, and alter the logo for better display against dark backgrounds.
  • v0.2.5: Really boring: Fix encoding-related issues, including broken room join dialogue with non-ASCII topics and send/receive inconsistencies for Windows-1252 encoded characters such as smart quotes.
  • v0.2.6: Add automatic focus on the input box in a number of cases, many debug improvements including exceptions and a raw HTML view, a fix for a Windows issue with the chatstream dying, and some minor fixes.

v0.3

New features since v0.2.6 include: optional spellcheck; greatly improved alert configurability and accuracy, including different settings when away; optional reminder of away status; and optional GeoIP lookups for op use. Fixes include: a Windows issue causing occasional line loss; correct result from right click -> Copy Link Location; some WebTab behaviour such as refresh and copy (on Windows); and other miscellaneous fixes.
  • v0.3.1: Add the ability to /purge without losing the entire backlog. Bug fixes including size and behaviour of input box, away state tracking, the /msg target box behaviour if the targeted user leaves, and the selection clipboard on Linux.
  • v0.3.2: Adds logging functionality and the option to display timestamps in the local timezone. Fixes the improved purge handling and numerous minor glitches, and tidies the settings dialogue a bit.
  • v0.3.3: Adds option to split private messages into separate tabs. Minor speed improvement to chatstream parsing, and a couple of minor fixes.
  • v0.3.4: Minor bugfixes. Removal of unused and broken tab detachment feature. Tools to distribute standalone Windows package.
  • v0.3.5: Adds a find function, detection of URLs in the topic, and the ability to show large versions of images in bot games. Improves message tab handling of bots and status changes. Fixes numerous minor issues including parsing and logging failures and incorrect spellcheck tokeniser behaviour.
  • v0.3.6: Minor fixes: Userlist parse failure in rare cases, CPU eating bug on dead network connection.
  • v0.3.7: Adds support for proxies. Fixes errors with Qt 4.8.
  • v0.3.8: Add notification on network connectivity issues and ability to scroll back through sent message history. Fix a chatstream refreshing issue after being kicked.
  • v0.3.9: Fix showing timestamps in local time and some odd topic link behaviour. Improve detection of network errors.
  • v0.3.10: Fix a crash displaying the userlist with non-ASCII labels.
  • v0.3.11: Adds a choice of log rotation frequency and a timestamp toggle for users who normally have timestamps off. Improves appearance of web tabs. Fixes bugs with long format timestamps in local time and userlist IP lookup.
  • v0.3.12: Adds shortcuts for timestamp toggling and focusing the input bar. Various fixes to parsing, timestamp toggling, and more.
  • v0.3.13: Fix some images in the chat stream, segfaulting on loading QtWebKit with some versions of Qt, and some encoding issues on Python 3.

v0.4

Add font choice configuration, improve detection of the stream dropping, and fixes including opening the log directory on Windows.
  • v0.4.1: Better handling of images.
  • v0.4.2: Ability to edit saved login details.
  • v0.4.3: Fix security flaw allowing PyRook users to be kicked from the room with a crafted message.

v0.5

Move to Python 3 only and PyQt, and move to distribution using PyPI. Add built-in updater. Add smiley hovertext.
  • v0.5.1: Qt5 compatibility fix.
  • v0.5.2: Add support for refreshing mode for compatibility with some proxies.