Metadata-Version: 2.1
Name: lavaplayer
Version: 1.0.5a0
Summary: A sample Python project
Home-page: https://github.com/HazemMeqdad/lavaplayer
Author: HazemMeqdad
Author-email: hazemmeqdad@gmail.com
License: UNKNOWN
Project-URL: Bug Reports, https://github.com/HazemMeqdad/lavaplayer/issues
Project-URL: Source, https://github.com/HazemMeqdad/lavaplayer/
Project-URL: Documentation, https://lavaplayer.readthedocs.io/en/latest
Keywords: lavalink,discord,discord-lavalink,lavaplayer
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3 :: Only
Description-Content-Type: text/markdown
License-File: LICENSE

<h1 align="center">
    <b>
        <a href="https://github.com/HazemMeqdad/lavaplayer">
            Lavaplayer
        </a>
    </b>
</h1>


<p align="center">
    <a href="https://discord.gg/VcWRRphVQB">Support Guild</a> |
    <a href="https://github.com/HazemMeqdad/lavaplayer/tree/main/examples">Examples</a> |
    <a href="https://lavaplayer.readthedocs.io/en/latest/">Documentation</a> |
    <a href="https://github.com/HazemMeqdad/lavaplayer">Source</a>
</p>

<br>

Its a lavalink nodes manger to make a music bots for discord with python.


# About

Lavaplayer is a nodes manager to connection with discord voice gateway, easy to create a music bot, you can use to anything async discord wrapper library

# Usage

example for create connecting with lavalink server using [hikari](https://github.com/hikari-py/hikari).

```python
import hikari
import lavaplayer

bot = hikari.GatewayBot("token")

lavalink = lavaplayer.LavalinkClient(
    host="localhost",
    port=2333,
    password="youshallnotpass",
    bot_id=123
)

@bot.listen(hikari.ShardReadyEvent)
async def start_lavalink(event):
    await lavalink.connect()

bot.run()
```

examples for some methods.
```python
# Auto search mix with track or query
await lavalink.auto_search_tracks("Rick Astley")

# Play track
await lavalink.play(guild_id, track)

# Skip
await lavalink.skip(guild_id)

# Pause
await lavalink.pause(guild_id, stats)

# Volume
await lavalink.volume(guild_id, volume)
```

# Features

- [ ] Spotify support
- [x] connection handler
- [ ] Support youtube playlist
- [ ] Add example for other discord wrapper library

# Installation

```shell
# Linux/OS X
$ pip3 install -U lavaplayer

# Windows
$ pip install -U lavaplayer
```





