A Discord wrapper for miniiric.
Project description
miniirc_discord
A wrapper for miniirc (GitHub, GitLab) to allow bots or clients made in miniirc to connect to (proprietary) Discord servers via discord.py with minimal code changes.
How to use
To use miniirc_discord, you already need to know how to use miniirc (GitHub,
GitLab). Instead of creating a miniirc.IRC
object, however, you need to
use miniirc_discord.Discord
. This is very similar, however has some
differences:
ip
is now your Discord token (see this guide to get one).port
,nick
,ident
andrealname
are currently ignored, however still need to be the expected type (port
should be0
or65536
).
Channels will start in #
if they are public and are currently just a channel
ID. Before you can send messages into a channel, however, someone needs to send
a message in one of them.
Currently only PRIVMSG
s (and CTCP ACTION
s) are supported, however PRs are
welcome.
You can use AWAY
to set the bot's "Playing" or "Streaming" text. Running this
command with an empty value will unset it.
Some formatting from IRC to Discord should be translated nicely, however more complex codes and formatting from Discord to IRC are currently not.
Installation and setting up
You can install miniirc_discord
with pip
. On Linux-based systems, you would
do sudo pip3 install miniirc_discord
. Version numbers should follow SemVer
since 0.4.0 and are no longer in sync with miniirc
until miniirc_discord
becomes more stable.
Manual installation
To install miniirc_discord
manually, you can usually place it in the same
directory as your other .py
files or in a package directory.
You will need to install the following dependencies (normally with pip3
):
discord.py
miniirc
Getting a bot token
To get a Discord bot token and invite link, see this guide.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for miniirc_discord-0.4.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | ae27b5cd1501168f0e7d50ec1566f1ce7d5ae177aa6865aa1e7416c2004222a3 |
|
MD5 | 5f3bcb203078fe46af6d7babec9adf01 |
|
BLAKE2b-256 | 652c99648198c096ef78c659133be979c57559013b69384673ec649b4ac4cdd7 |