user333/irc2bash
1
0
Fork 0
mirror of https://github.com/a-bad-dev/irc2bash.git synced 2026-06-09 17:42:40 +00:00
Code Issues Projects Releases Packages Wiki Activity

fix newlines

Browse source
This commit is contained in:
a-bad-dev 2026-03-27 00:57:56 -03:00 • committed by GitHub
commit 1e2c4f2b68
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 35 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

37
README.md
View file

@ -1,36 +1,69 @@
# irc2bash # irc2bash
A bridge between an IRC channel and the bash interpreter. A bridge between an IRC channel and the bash interpreter.
Ensure you run this in a sandboxed VM unless you want random people messing with your PC remotely. Ensure you run this in a sandboxed VM unless you want random people messing with your PC remotely.
This also works with sh, zsh, csh, and (probably) fish. This also works with sh, zsh, csh, and (probably) fish.
# Installing # Installing
## Linux ## Linux
Clone the repository. Clone the repository.
`git clone --depth=1 https://github.com/a-bad-dev/irc2bash.git` `git clone --depth=1 https://github.com/a-bad-dev/irc2bash.git`
`cd irc2bash/` `cd irc2bash/`
Set up the config file (`skel_config.py`) with the editor of your choice. Set up the config file (`skel_config.py`) with the editor of your choice.
The important settings are: The important settings are:
`realname`: Set this to the real name of your bot, use `rce` if unsure. `realname`: Set this to the real name of your bot, use `rce` if unsure.
`nickname`: Set this to the nickname of your bot, this is the name you probably want to change. Use `rce-bot` or something similar if unsure.
`nickname`: Set this to the nickname of your bot, this is the name you probably want to change. Use `rce-bot` or something similar
if unsure.
`channels`: Sdd channels to this list for your bot to join. `channels`: Sdd channels to this list for your bot to join.
`ip`: Set this to the IP or domain name of the IRC server `ip`: Set this to the IP or domain name of the IRC server
`port`: Set this to the port of the IRC server. Use `6667` if unsure. `port`: Set this to the port of the IRC server. Use `6667` if unsure.
`ssl`: Enable this to use SSL. Set to `False` if unsure. `ssl`: Enable this to use SSL. Set to `False` if unsure.
`command_prefix`: The prefix used before commands sent to the bash interpreter. Set this to `$` if unsure. `command_prefix`: The prefix used before commands sent to the bash interpreter. Set this to `$` if unsure.
`bot_prefix`: The prefix used before commands that control the bot itself. Set this to `#` if unsure. `bot_prefix`: The prefix used before commands that control the bot itself. Set this to `#` if unsure.
`opper_nicknames`: List of nicknames allowed to control the bot. Set this to your own nick if unsure. `opper_nicknames`: List of nicknames allowed to control the bot. Set this to your own nick if unsure.
Rename the config file so the script can detect it. Rename the config file so the script can detect it.
`mv skel_config.py config.py` `mv skel_config.py config.py`
Run the bot. Run the bot.
`python3 main.py` `python3 main.py`
or or
`chmod +x main.py` `chmod +x main.py`
`./main.py` `./main.py`
A systemd service is included if you want the bot to start on boot. For non-systemd systems, use a cron job running at reboot or something similar.
A systemd service is included if you want the bot to start on boot. For non-systemd systems, use a cron job running at reboot or
something similar.
## Windows ## Windows
go get a real OS go get a real OS