adminsys/welcomebot
adminsys/welcomebot
9
0
Fork 0
Code Issues Pull Requests Releases Activity

Update README.md

Browse Source
This commit is contained in:
shaunagm 2014-02-08 12:14:12 -05:00
parent c3f6f90c33
commit bbe9164766
1 changed files with 18 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
README.md
View File

@ -1,44 +1,37 @@
# What is this
## What is this?
oh-irc-bot (potential name: Nightlightbot) is a bot for welcoming people into the #openhatch irc channel
oh-irc-bot (or "WelcomeBot", its IRC nick) is a bot for welcoming people into the #openhatch irc channel
when no one is paying attention. The goals are to:
1. alert community members when someone knew enters the room and says hello (either by using their nick
in a response, or by sending a private message)
2. helping a person to feel welcome even when there's no one around, and providing more information about
2. help a person to feel welcome even when there's no one around, and providing more information about
staying in touch
# Deets
## Basic Structure
## Response conditions
<code>bot.py</code> is the project's main file. It uses the socket module to communicate and gathers a list of known IRC nicknames, stored in <code>nicks.csv</code>. Its basic functions include:
Proposed
1. If someone enters the channel, the bot checks to see if they are a known nick. If not, it adds them to a list of people to greet. If no one else has spoken into the channel after 60 seconds, it greets them. If someone else (not the new nick) speaks into the channel within 60 seconds, or if the nick is known, the bot remains silent. The bots response text includes the nicks of channel maintainers/frequent contributors so that they are pinged.
2. If someone says hello to the bot, the bot says hello back.
3. If someone asks the bot for information (via key phrases like "help", "faq", etc) the bot explains what it is and links to this repository.
1. someone joins; says hi/hey/hello; no one responds for X seconds; bot RESPONDS [YES]
2. someone joins; says nothing for Y seconds; no one responds for X seconds; bot checks list of known nicks:
- if unknown RESPONDS
- if known PMs maintainers
3. someone says hi/hey/hello with no nicks in channel after it; no one responds for X seconds; bot RESPONDS ?
## Setting up
## Responses
To run the bot:
May
1. Download the repository. If you need help using github, see [here](https://openhatch.org/wiki/Git_Basics).
2. Edit bot.py to change the nickname to something besides "WelcomeBot" and the channel to "openhatch-bots".
2. Open up a command line and type <code>python bot.py</code>.
3. Although all IRC messages should be printed to your command line, for development purposes, it will probably be useful to be on IRC separately using your normal nick.
* Include "maintainers" nicks so they get pinged?
* Suggest waiting til the morning, or emailing.
If you run into setup difficulties, ping shauna on freenode (via the #openhatch channel is preferred) and/or leave an issue in this repository's issue tracker.
## Implementation ideas
## How to help
May want to keep a list of known nicks so channel regulars aren't constantly getting bugged by the bot.
The [issue tracker](https://github.com/shaunagm/oh-irc-bot/issues?state=open) lists improvements we want to make. Please feel free to submit pull requests to address these issues. If you're not familiar with how to do this using github, see [here](https://openhatch.org/wiki/Git_Basics). You can also ask me for clarification (again, I am shauna on the #openhatch IRC.)
# How to help
Find me (shauna) on the #openhatch IRC. Alternatively you can fork this project, make changes, and send
them back if you want. If you need help using github, see [here](https://openhatch.org/wiki/Git_Basics).
I will come back and improve this documentation later.
# Credit
## Credit
This bot was adapted from code found [here](http://wiki.shellium.org/w/Writing_an_IRC_bot_in_Python).