<commit_before>
========
HanabIRC
========

An IRC bot that organizes and plays the card game Hanabi.

Installing and running the hanabot:
-----------------------------------
To run the game on your own channel do the following:

Download and install hanabIRC and dependencies:

> sudo pip install hanabIRC

Generate a default configuration file:

> sudo hanabIRC --makeconf > /etc/hanabIRC.conf

Edit the default configuration:

> vi /etc/hanabIRC.conf

Run the bot:

> hanabIRC

You may want to save the log file and run it in the background:

> hanabIRC 2>&1 > hanabIRC.log & 

History
=======

* 2013-02-13 - Initial creation. (See git logs for history.)
* 2013-02-13 - Interface updates after user feedback.
* 2013-02-14 
	- Added mutli-channel support. Hanbot can now run in multiple channels, keeping track of multiple games.
	- Enforce one person per game
	- Use NOTICE instead of prvimsg to display text inline to user/channel.
* 2013-02-14 - Version 0.1.4 - added support for rainbow cards. When starting a game, add "rainbow" to start command to use them: "!start rainbow".


TODO:
-----
- add support for telling non command issuer stuff. 
	This could be used to show hands to all players
	after a !play, for example.
- do not print hint to channel if given in a PRIVMSG
- add total time game took at end game?
- keep stats?
- add user-configured color to the bot
- PM user with updated hands when it is their turn
- add !replace command to replace people in-game
<commit_msg>added TODOs from feedback.<commit_after>
========
HanabIRC
========

An IRC bot that organizes and plays the card game Hanabi.

Installing and running the hanabot:
-----------------------------------
To run the game on your own channel do the following:

Download and install hanabIRC and dependencies:

> sudo pip install hanabIRC

Generate a default configuration file:

> sudo hanabIRC --makeconf > /etc/hanabIRC.conf

Edit the default configuration:

> vi /etc/hanabIRC.conf

Run the bot:

> hanabIRC

You may want to save the log file and run it in the background:

> hanabIRC 2>&1 > hanabIRC.log & 

History
=======

* 2013-02-13 - Initial creation. (See git logs for history.)
* 2013-02-13 - Interface updates after user feedback.
* 2013-02-14 
	- Added mutli-channel support. Hanbot can now run in multiple channels, keeping track of multiple games.
	- Enforce one person per game
	- Use NOTICE instead of prvimsg to display text inline to user/channel.
* 2013-02-14 - Version 0.1.4 - added support for rainbow cards. When starting a game, add "rainbow" to start command to use them: "!start rainbow".


TODO:
-----
- add support for telling non command issuer stuff. 
	This could be used to show hands to all players
	after a !play, for example.
- do not print hint to channel if given in a PRIVMSG
- add total time game took at end game?
- keep stats?
- add user-configured color to the bot
- PM user with updated hands when it is their turn
- add !replace command to replace people in-game
- add actual rules text
- make sure when a player leaves, they do not still get PMs.
- When you run out of cards, everyone gets one more turn.

{'fraction_non_alphanumeric': 0.09897828863346105, 'fraction_numerical': 0.02362707535121328, 'mean_word_length': 3.1773333333333333, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 19, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 2, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '2161016', 'n_tokens_mistral': 977, 'n_tokens_neox': 896, 'n_words': 454}