-
Notifications
You must be signed in to change notification settings - Fork 187
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
2 changed files
with
107 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
MIT License | ||
|
||
Copyright (c) 2019-Current PythonistaGuild, EvieePy | ||
|
||
Permission is hereby granted, free of charge, to any person obtaining a copy | ||
of this software and associated documentation files (the "Software"), to deal | ||
in the Software without restriction, including without limitation the rights | ||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
copies of the Software, and to permit persons to whom the Software is | ||
furnished to do so, subject to the following conditions: | ||
|
||
The above copyright notice and this permission notice shall be included in all | ||
copies or substantial portions of the Software. | ||
|
||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
SOFTWARE. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,86 @@ | ||
.. image:: https://raw.githubusercontent.com/PythonistaGuild/Wavelink/master/logo.png | ||
|
||
|
||
.. image:: https://img.shields.io/badge/Python-3.8%20%7C%203.9%20%7C%203.10-blue.svg | ||
:target: https://www.python.org | ||
|
||
|
||
.. image:: https://img.shields.io/github/license/EvieePy/Wavelink.svg | ||
:target: LICENSE | ||
|
||
|
||
.. image:: https://img.shields.io/discord/490948346773635102?color=%237289DA&label=Pythonista&logo=discord&logoColor=white | ||
:target: https://discord.gg/RAKc3HF | ||
|
||
|
||
.. image:: https://img.shields.io/pypi/dm/Wavelink?color=black | ||
:target: https://pypi.org/project/Wavelink | ||
:alt: PyPI - Downloads | ||
|
||
|
||
.. image:: https://img.shields.io/maintenance/yes/2023?color=pink&style=for-the-badge | ||
:target: https://github.com/PythonistaGuild/Wavelink/commits/main | ||
:alt: Maintenance | ||
|
||
|
||
|
||
Wavelink is a robust and powerful Lavalink wrapper for `Discord.py <https://github.com/Rapptz/discord.py>`_ and certain supported forks. | ||
Wavelink features a fully asynchronous API that's intuitive and easy to use with built in Spotify Support and Node Pool Balancing. | ||
|
||
**This is the 2.0 Beta Release of Wavelink that suppports Lavalinks 3.7+ REST API.** | ||
Please use this version of wavelink for testing and contributing purposes only. | ||
|
||
|
||
Documentation | ||
--------------------------- | ||
`Official Documentation <https://wavelink.readthedocs.io/en/latest/wavelink.html>`_ | ||
|
||
Support | ||
--------------------------- | ||
For support using WaveLink, please join the official `support server | ||
<https://discord.gg/RAKc3HF>`_ on `Discord <https://discordapp.com/>`_. | ||
|
||
.. image:: https://discordapp.com/api/guilds/490948346773635102/widget.png?style=banner2 | ||
:target: https://discord.gg/RAKc3HF | ||
|
||
|
||
Installation | ||
--------------------------- | ||
The following commands are currently the valid ways of installing WaveLink. | ||
|
||
**WaveLink 2 requires Python 3.10+** | ||
|
||
**Windows** | ||
|
||
.. code:: sh | ||
py -3.10 -m pip install -U Wavelink --pre | ||
**Linux** | ||
|
||
.. code:: sh | ||
python3.10 -m pip install -U Wavelink --pre | ||
Getting Started | ||
---------------------------- | ||
|
||
Coming soon... | ||
|
||
|
||
Lavalink Installation | ||
--------------------- | ||
|
||
Head to the official `Lavalink repo <https://github.com/freyacodes/Lavalink#server-configuration>`_ and give it a star! | ||
|
||
- Create a folder for storing Lavalink.jar and related files/folders. | ||
- Copy and paste the example `application.yml <https://github.com/freyacodes/Lavalink#server-configuration>`_ to ``application.yml`` in the folder we created earlier. You can open the yml in Notepad or any simple text editor. | ||
- Change your password in the ``application.yml`` and store it in a config for your bot. | ||
- Set local to true in the ``application.yml`` if you wish to use ``wavelink.LocalTrack`` for local machine search options... Otherwise ignore. | ||
- Save and exit. | ||
- Install `Java 17(Windows) <https://download.oracle.com/java/17/latest/jdk-17_windows-x64_bin.exe>`_ or **Java 13+** on the machine you are running. | ||
- Download `Lavalink.jar <https://ci.fredboat.com/viewLog.html?buildId=lastSuccessful&buildTypeId=Lavalink_Build&tab=artifacts&guest=1>`_ and place it in the folder created earlier. | ||
- Open a cmd prompt or terminal and change directory ``cd`` into the folder we made earlier. | ||
- Run: ``java -jar Lavalink.jar`` | ||
|
||
If you are having any problems installing Lavalink, please join the official Discord Server listed above for help. |