pomice/docs/installation.md

1.4 KiB

Installation

This library is designed to work with the Lavalink audio delivery system, which directly interfaces with Discord to provide buttery smooth audio without wasting your precious system resources.

Pomice is made with convenience to the user, in that everything is easy to use and is out of your way, while also being customizable.

In order to start using this library, please download a Lavalink node to start, you can get it here

After you have your Lavalink node set up, you can install Pomice:

pip install pomice

Pomice will handle installing all required dependencies for you so you can start coding with it without a hitch.

After you installed Pomice, get familiar with how it works by starting out with an example.

If you need more than just a quick example, get our drop-in advanced cog to take advantage of all of Pomice's features. You are free to use this as a base to add on to for any music features you want to implement within your application.

If you want to jump into the library and learn how to do everything you need, refer to the How Do I? section.

If you want a deeper look into how the library works beyond the How Do I? guide, refer to the API Reference section.