Skip to main content

A Discord wrapper for miniirc.

Project description

miniirc_discord

Available on PyPI.

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.

Some formatting from IRC to Discord should be translated nicely, however more complex codes and formatting from Discord to IRC are currently not.

Supported commands

PRIVMSG

PRIVMSG operates like you'd expect and IRC formatting codes are converted to markdown. You cannot, however, send messages to a channel before the bot has received a message from the channel.

CTCP ACTION (irc.me())

This works similarly to PRIVMSG, except the CTCP ACTION is also converted to a Discord /me.

NOTICE

Before miniirc_discord 0.5.0, NOTICE is an alias for PRIVMSG.

NOTICE adds nice embeds into Discord, while remaining as compatible as possible with IRC. You can set the IRCv3 client tag +discordapp.com/title to set the embed title (note that this will not be displayed on IRC), and add an IRC colour/color code to the start of the line to set the embed colour/color. Only codes 0 to 9 are currently supported, and using leading zeroes (03 or 05) will break.

AWAY

AWAY will set the bot's "Playing" text. If you want to change the prefix to something else, you can set the IRCv3 client tag +discordapp.com/type to (Playing, Streaming, Listening to or Watching). The +discordapp.com/status tag can be set to 'online', 'idle', 'dnd' or 'invisible'.

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


Download files

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

Files for miniirc-discord, version 0.5.14
Filename, size File type Python version Upload date Hashes
Filename, size miniirc_discord-0.5.14-py3-none-any.whl (6.8 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size miniirc_discord-0.5.14.tar.gz (5.8 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page