1- # Important:
2-
3- Wavelink is no longer maintained. Visit [ Lavalink Client] ( https://lavalink.dev/clients ) for a list of current libraries.
4-
5-
6-
7-
81<div align =" center " >
92
103
@@ -20,78 +13,71 @@ Wavelink is no longer maintained. Visit [Lavalink Client](https://lavalink.dev/c
2013</div >
2114
2215
23- Wavelink is a robust and powerful Lavalink wrapper for [ Discord.py ] ( https://github.com/Rapptz/ discord.py )
24- Wavelink features a fully asynchronous API that's intuitive and easy to use.
16+ Wavelink is a powerful Lavalink wrapper for Python discord libraries featuring a stateful, event-driven design
17+ that's intuitive and easy to use.
2518
2619
27- # Migrating from Version 2 to Version 3:
20+ ### Supported Libraries
2821
29- [ Migrating Guide] ( https://wavelink.dev/en/latest/migrating.html )
22+ - ** discord.py**
23+ - ** pycord**
24+ - ** nextcord**
25+ - ** disnake**
26+ - ** Others may be supported**
3027
3128
3229### Features
3330
34- - Full asynchronous design.
35- - Lavalink v4+ Supported with REST API.
36- - discord.py v2.0.0+ Support.
31+ - Stateful, event-driven design
32+ - Asychronous first with faster websockets using Picows.
33+ - Lavalink v4+ and Nodelink support; including plugins.
34+ - All popular discord libraries supported.
3735- Advanced AutoPlay and track recommendations for continuous play.
38- - Object orientated design with stateful objects and payloads.
3936- Fully annotated and complies with Pyright strict typing.
4037
4138
42- ## Getting Started
39+ ## Migrating from Version 3 to Version 4:
4340
44- ** See Examples: ** [ Examples ] ( https://github.com/PythonistaGuild/Wavelink/tree/main/examples )
41+ [ Migrating Guide ] ( https://wavelink.rtfd.cc )
4542
46- ** Lavalink:** [ GitHub] ( https://github.com/lavalink-devs/Lavalink/releases ) , [ Webpage] ( https://lavalink.dev )
4743
44+ ## Getting Started
4845
49- ## Documentation
46+ ...
5047
51- [ Official Documentation] ( https://wavelink.dev/en/latest )
5248
53- ## Support
49+ ## Documentation
5450
55- For support using WaveLink, please join the official [ Support Server] ( https://discord.gg/RAKc3HF ) on
56- [ Discord] ( https://discordapp.com )
57-
58- [ ![ Discord Banner] ( https://discordapp.com/api/guilds/490948346773635102/widget.png?style=banner2 )] ( https://discord.gg/RAKc3HF )
51+ [ Official Documentation] ( https://wavelink.rtfd.cc )
5952
6053
6154## Installation
6255
63- ** WaveLink 3 requires Python 3.10+**
64-
65- ** Windows**
66-
67-
68- ``` sh
69- py -3.10 -m pip install -U wavelink
70- ```
71-
72- ** Linux**
56+ ** UV**
7357
74- ``` sh
75- python3.10 -m pip install -U wavelink
58+ ``` shell
59+ uv add wavelink
7660```
7761
78- ** Virtual Environments **
62+ ** pip **
7963
80- ``` sh
64+ ``` shell
8165pip install -U wavelink
8266```
8367
8468
8569## Lavalink
8670
87- Wavelink ** 3 ** requires ** Lavalink v4** .
71+ ** Lavalink v4+ ** is required .
8872See: [ Lavalink] ( https://github.com/lavalink-devs/Lavalink/releases )
8973
90- For spotify support, simply install and use [ LavaSrc] ( https://github.com/topi314/LavaSrc ) with your ` wavelink.Playable `
74+ For spotify support, simply install and use [ LavaSrc] ( https://github.com/topi314/LavaSrc )
9175
9276
93- ### Notes
77+ ## Support
78+
79+ For support using WaveLink, please join the official [ Support Server] ( https://discord.gg/RAKc3HF ) on
80+ [ Discord] ( https://discordapp.com )
81+
82+ [ ![ Discord Banner] ( https://discordapp.com/api/guilds/490948346773635102/widget.png?style=banner2 )] ( https://discord.gg/RAKc3HF )
9483
95- - Wavelink ** 3** is compatible with Lavalink ** v4+** .
96- - Wavelink has built in support for Lavalink Plugins including LavaSrc and SponsorBlock.
97- - Wavelink is fully typed in compliance with Pyright Strict, though some nuances remain between discord.py and wavelink.
0 commit comments