3b1b26ffb1
This is a complete redesign of the old voice code. A list of major changes is as follows: * The voice websocket will now automatically reconnect with exponential back-off just like the regular Client does. * Removal of the stream player concept. * Audio now gracefully pauses and resumes when a disconnect is found. * Introduce a discord.AudioSource concept to abstract streams * Flatten previous stream player functionality with the VoiceClient, e.g. player.stop() is now voice_client.stop() * With the above re-coupling this means you no longer have to store players anywhere. * The after function now requires a single parameter, the error, if any existed. This will typically be None. A lot of this design is experimental.
discord.py
discord.py is an API wrapper for Discord written in Python.
This was written to allow easier writing of bots or chat logs. Make sure to familiarise yourself with the API using the documentation.
Breaking Changes
The discord API is constantly changing and the wrapper API is as well. There will be no effort to keep backwards compatibility in versions before v1.0.0.
I recommend that you follow the discussion in the unofficial Discord API discord channel and update your installation periodically. I will attempt to make note of breaking changes in the API channel so make sure to subscribe to library news by typing ?sub news in the channel.
Installing
To install the library without full voice support, you can just run the following command:
python3 -m pip install -U discord.py
Otherwise to get voice support you should run the following command:
python3 -m pip install -U discord.py[voice]
To install the development version, do the following:
python3 -m pip install -U https://github.com/Rapptz/discord.py/archive/master.zip#egg=discord.py[voice]
or the more long winded from cloned source:
$ git clone https://github.com/Rapptz/discord.py
$ cd discord.py
$ python3 -m pip install -U .[voice]
Please note that on Linux installing voice you must install the following packages via your favourite package manager (e.g. apt, yum, etc) before running the above command:
- libffi-dev (or
libffi-develon some systems) - python-dev (e.g.
python3.5-devfor Python 3.5)
Quick Example
import discord
import asyncio
class MyClient(discord.Client):
async def on_ready(self):
print('Logged in as')
print(self.user.name)
print(self.user.id)
print('------')
async def on_message(self, message):
if message.content.startswith('!test'):
counter = 0
tmp = await message.channel.send('Calculating messages...')
async for msg in message.channel.history(limit=100):
if msg.author == message.author:
counter += 1
await tmp.edit(content='You have {} messages.'.format(counter))
elif message.content.startswith('!sleep'):
with message.channel.typing():
await asyncio.sleep(5.0)
await message.channel.send('Done sleeping.')
client = MyClient()
client.run('token')
Note that in Python 3.4 you use @asyncio.coroutine instead of async def and yield from instead of await.
You can find examples in the examples directory.
Requirements
- Python 3.4.2+
aiohttplibrarywebsocketslibraryPyNaCllibrary (optional, for voice only)- On Linux systems this requires the
libffilibrary. You can install in debian based systems by doingsudo apt-get install libffi-dev.
- On Linux systems this requires the
Usually pip will handle these for you.