https://github.com/fharchive/python.ircbot
Use sockets to attempt to join an irc channel and talk with a bot
https://github.com/fharchive/python.ircbot
ircbot python sockets
Last synced: 9 months ago
JSON representation
Use sockets to attempt to join an irc channel and talk with a bot
- Host: GitHub
- URL: https://github.com/fharchive/python.ircbot
- Owner: FHArchive
- License: mit
- Created: 2019-03-08T13:21:16.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2020-01-13T11:07:44.000Z (almost 6 years ago)
- Last Synced: 2025-02-09T10:42:03.710Z (11 months ago)
- Topics: ircbot, python, sockets
- Language: Python
- Size: 71.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Python.IRCBot
Use sockets to attempt to join an IRC channel and talk with a bot
## Download
### Clone
#### Using The Command Line
1. Press the Clone or download button in the top right
2. Copy the URL (link)
3. Open the command line and change directory to where you wish to clone to
4. Type 'git clone' followed by URL in step 2
```bash
$ git clone https://github.com/[user-name]/[repository]
```
More information can be found at
#### Using GitHub Desktop
1. Press the Clone or download button in the top right
2. Click open in desktop
3. Choose the path for where you want and click Clone
More information can be found at
### Download Zip File
1. Download this GitHub repository
2. Extract the zip archive
3. Copy/ move to the desired location
## Language information
### Built for
This program has been written for Python 3 and has been tested with
Python version 3.7.0
on a Windows 10 PC.
### Other versions
To install Python, go to and download the latest
version.
## How to run
1. Open the .py file in IDLE
2. Run by pressing F5 or by selecting Run> Run Module
## What this program does
- Read configuration data from a json file ('data.json'). In the form:
```json
{
"host_url": "irc.hostname.org",
"protocol": "IRC",
"port": 6667,
"irc_channel": "#channel",
"bot_name": "bot_name",
"user_name": "user_name",
"user_password": "user_password"
}
```
- Gets a message in its raw from
```python
getRawMessage()
```
- Takes a raw message and refines it (name, message)
```python
getRefinedMessage(messageData)
```
- Starts an IRC connection, signs in and goes to the desired channel
- Ignore the welcome messages
## Add your own application code
You can add code to talk to the target bot
deal with any responses and deal with them appropriately. For instance you may
want to implement a 'chatbot' or answer challenge questions (in the case of
root-me)
## Example code
Send a private message to our target bot
```python
irc.send(bytes("PRIVMSG "+ bot_name +" :"+ "my message here" +"\n", "UTF-8"))
```
Get a message from the bot
```python
messageData = getRawMessage()
if (DEBUG):
print(messageData)
name, message = getRefinedMessage(messageData)
print(name, message)
```
## Licence
MIT License
Copyright (c) fredhappyface
(See the [LICENSE](/LICENSE.md) for more information.)