Skip to main content

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 and realname are currently ignored, however still need to be the expected type (port should be 0 or 65536).

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 PRIVMSGs (and CTCP ACTIONs) 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. pip's version numbers have the same MAJOR and MINOR as miniirc, however PATCH may vary.

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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

miniirc_discord-0.3.11.tar.gz (3.6 kB view hashes)

Uploaded Source

Built Distribution

miniirc_discord-0.3.11-py3-none-any.whl (4.7 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page