Skip to content

Commit

Permalink
* Add .gitignore
Browse files Browse the repository at this point in the history
* Update readme and changelog.
* Change all the things.
  • Loading branch information
dewiniaid committed Mar 13, 2016
1 parent 53dadc5 commit e02b4ef
Show file tree
Hide file tree
Showing 3 changed files with 436 additions and 138 deletions.
61 changes: 61 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
### Python template
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class

# C extensions
*.so

# Distribution / packaging
.Python
env/
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
*.egg-info/
.installed.cfg
*.egg

# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec

# Installer logs
pip-log.txt
pip-delete-this-directory.txt

# Unit test / coverage reports
htmlcov/
.tox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*,cover

# Translations
*.mo
*.pot

# Django stuff:
*.log

# Sphinx documentation
docs/_build/

# PyBuilder
target/

# Created by .ignore support plugin (hsz.mobi)
36 changes: 23 additions & 13 deletions alerts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,28 +3,38 @@ Improved alerts for Hexchat

## Requirements
* [Hexchat](https://hexchat.github.io/) version 2.10 or later
* Hexchat's Python 3 plugin. (Does not currently work Python 2.x). Use `/py about` to see if the plugin is installed and the version of Python it expects. The easiest way to get the plugin on Windows is to rerun the Hexchat installer.
* The correct version of [Python](https://www.python.org/downloads/) for the Python 3 plugin. (You cannot use newer versions.)
* Hexchat's Python 3 plugin. (Does not currently work Python 2.x). Use `/py about` to see if the plugin is installed
and the version of Python it expects. The easiest way to get the plugin on Windows is to rerun the Hexchat installer.
* The correct version of [Python](https://www.python.org/downloads/) for the Python 3 plugin. (Newer versions will not
work.)
- Hexchat 2.10.2 required Python **3.4.x**
- Hexchat 2.12 requires Python **3.5.x**

## Installation Instructions
1. Save `alerts.py` to your Hexchat addons directory. On Windows, this is located at `%appdata%\HexChat\addons`. On Linux and OSX, this is probably `./config/hexchat/addons`
2. Ensure the correctPython plugin is enabled in Hexchat. You can check with `/py about`.
- If nothing shows up, the easiest way to fix this is to rerun the Hexchat installer and select to install the Python 3 plugin.
1. Save `alerts.py` to your Hexchat addons directory. On Windows, this is located at `%appdata%\HexChat\addons`.
On Linux and OSX, this is probably `./config/hexchat/addons`
2. Ensure the correct Python plugin is enabled in Hexchat. You can check with `/py about`.
- If nothing shows up, the easiest way to fix this is to rerun the Hexchat installer and select to install the
Python 3 plugin.
3. Type `/py load alerts.py` in Hexchat, or restart Hexchat and the script should automatically load.
4. Type `/alerts help` to see documentation for creating alerts, or see the top of alerts.py
4. Type `/alerts help` to see documentation for creating alerts, or read

## Known Issues
* If Hexchat tries to play a sound from a highlight/PM at the same time this plugin does, Hexchat's sounds wins. Turn off the highlight sounds in Hexchat if this is the case.
* Sound is untested on anything but Windows. Sounds must be .wav files.

## Planned features/wishlist:
* Option to focus the window an alert occurs in.
* Option to filter alerts by channel/etc.
* Option to copy messages or some subset thereof to the current window.
* If Hexchat tries to play a sound from a highlight/PM at the same time this plugin does, Hexchat's sound will win.
Turn off the highlight sounds in Hexchat if this is an issue.
* Sound is untested on anything but Windows. Sounds must be playable using Hexchat's `/SPLAY` command.

## Changelog
### 0.5
* Add `/alerts colors` which displays a sample of all of the colors by number.
* Add `/alerts set copy ON|OFF|windowtitle` to copy all triggering messages to a custom query window.
* Add `/alerts focus ON|OFF|FORCE` to focus the window that receives an alert. If enabled, Hexchat will switch to the
target window. This will *NOT* steal focus from outside of Hexchat. It also will not change windows if you have
text entered (to avoid accidentally finishing your sentence in the new window) unless you choose *FORCE*
* Add `/alerts notify`, which notifies you in your current window if receiving an alert in a different one.
* Fix several small bugs
* Found lots of new and exciting ways to cras Hexchat and hopefully worked around all of them.

### 0.4
* Lots of bugfixes and code tidying.
* Probably some new bugs.
Expand Down
Loading

0 comments on commit e02b4ef

Please sign in to comment.