213 lines
18 KiB
HTML
213 lines
18 KiB
HTML
<!DOCTYPE html>
|
|
<html class="writer-html5" lang="en" >
|
|
<head>
|
|
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
|
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
<title>Welcome to Pomice! — Pomice 1.1.1 documentation</title>
|
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
|
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
|
<!--[if lt IE 9]>
|
|
<script src="_static/js/html5shiv.min.js"></script>
|
|
<![endif]-->
|
|
|
|
<script data-url_root="./" id="documentation_options" src="_static/documentation_options.js"></script>
|
|
<script src="_static/jquery.js"></script>
|
|
<script src="_static/underscore.js"></script>
|
|
<script src="_static/doctools.js"></script>
|
|
<script src="_static/js/theme.js"></script>
|
|
<link rel="index" title="Index" href="genindex.html" />
|
|
<link rel="search" title="Search" href="search.html" />
|
|
<link rel="next" title="<no title>" href="modules.html" />
|
|
</head>
|
|
|
|
<body class="wy-body-for-nav">
|
|
<div class="wy-grid-for-nav">
|
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
|
|
<div class="wy-side-scroll">
|
|
<div class="wy-side-nav-search" >
|
|
<a href="#" class="icon icon-home"> Pomice
|
|
</a>
|
|
<div role="search">
|
|
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
|
<input type="text" name="q" placeholder="Search docs" />
|
|
<input type="hidden" name="check_keywords" value="yes" />
|
|
<input type="hidden" name="area" value="default" />
|
|
</form>
|
|
</div>
|
|
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="pomice.html">Pomice</a></li>
|
|
</ul>
|
|
|
|
</div>
|
|
</div>
|
|
</nav>
|
|
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
|
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
|
<a href="#">Pomice</a>
|
|
</nav>
|
|
|
|
<div class="wy-nav-content">
|
|
<div class="rst-content">
|
|
<div role="navigation" aria-label="Page navigation">
|
|
<ul class="wy-breadcrumbs">
|
|
<li><a href="#" class="icon icon-home"></a> »</li>
|
|
<li>Welcome to Pomice!</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
<a href="_sources/index.rst.txt" rel="nofollow"> View page source</a>
|
|
</li>
|
|
</ul>
|
|
<hr/>
|
|
</div>
|
|
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
|
|
<div itemprop="articleBody">
|
|
|
|
<section id="welcome-to-pomice">
|
|
<h1>Welcome to Pomice!<a class="headerlink" href="#welcome-to-pomice" title="Permalink to this headline"></a></h1>
|
|
<img alt="https://raw.githubusercontent.com/cloudwithax/pomice/main/banner.jpg" src="https://raw.githubusercontent.com/cloudwithax/pomice/main/banner.jpg" />
|
|
<p>The modern <a class="reference external" href="https://github.com/freyacodes/Lavalink">Lavalink</a> wrapper designed for <a class="reference external" href="https://github.com/Rapptz/discord.py">discord.py</a></p>
|
|
<section id="contents">
|
|
<h2>Contents<a class="headerlink" href="#contents" title="Permalink to this headline"></a></h2>
|
|
<div class="toctree-wrapper compound">
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="pomice.html">Pomice</a><ul>
|
|
<li class="toctree-l2"><a class="reference internal" href="pomice.spotify.html">Spotify</a><ul>
|
|
<li class="toctree-l3"><a class="reference internal" href="pomice.spotify.html#module-pomice.spotify.album">spotify.Album</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="pomice.spotify.html#module-pomice.spotify.client">spotify.Client</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="pomice.spotify.html#module-pomice.spotify.exceptions">spotify.Exceptions</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="pomice.spotify.html#module-pomice.spotify.playlist">spotify.Playlist</a></li>
|
|
<li class="toctree-l3"><a class="reference internal" href="pomice.spotify.html#module-pomice.spotify.track">spotify.Track</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference internal" href="pomice.html#module-pomice.enums">Enums</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="pomice.html#module-pomice.events">Events</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="pomice.html#module-pomice.exceptions">Exceptions</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="pomice.html#module-pomice.filters">Filters</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="pomice.html#module-pomice.objects">Objects</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="pomice.html#module-pomice.player">Player</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="pomice.html#module-pomice.pool">Pool</a></li>
|
|
<li class="toctree-l2"><a class="reference internal" href="pomice.html#module-pomice.utils">Utils</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</section>
|
|
<section id="before-you-start">
|
|
<h2>Before You Start<a class="headerlink" href="#before-you-start" title="Permalink to this headline"></a></h2>
|
|
<p>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.</p>
|
|
<p>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.</p>
|
|
<p>In order to start using this library, please download a Lavalink node to start,
|
|
you can get it <a class="reference external" href="https://github.com/freyacodes/Lavalink/releases/latest">here</a></p>
|
|
</section>
|
|
<section id="quick-jumpstart">
|
|
<h2>Quick Jumpstart<a class="headerlink" href="#quick-jumpstart" title="Permalink to this headline"></a></h2>
|
|
<p>If you want a quick example as to how to start with Pomice, look below:</p>
|
|
<div class="highlight-python3 notranslate"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">pomice</span>
|
|
<span class="kn">import</span> <span class="nn">discord</span>
|
|
<span class="kn">import</span> <span class="nn">re</span>
|
|
|
|
<span class="kn">from</span> <span class="nn">discord.ext</span> <span class="kn">import</span> <span class="n">commands</span>
|
|
|
|
<span class="n">URL_REG</span> <span class="o">=</span> <span class="n">re</span><span class="o">.</span><span class="n">compile</span><span class="p">(</span><span class="sa">r</span><span class="s1">'https?://(?:www\.)?.+'</span><span class="p">)</span>
|
|
|
|
<span class="k">class</span> <span class="nc">MyBot</span><span class="p">(</span><span class="n">commands</span><span class="o">.</span><span class="n">Bot</span><span class="p">):</span>
|
|
|
|
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
|
<span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">(</span><span class="n">command_prefix</span><span class="o">=</span><span class="s1">'!'</span><span class="p">,</span> <span class="n">activity</span><span class="o">=</span><span class="n">discord</span><span class="o">.</span><span class="n">Activity</span><span class="p">(</span><span class="nb">type</span><span class="o">=</span><span class="n">discord</span><span class="o">.</span><span class="n">ActivityType</span><span class="o">.</span><span class="n">listening</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="s1">'to music!'</span><span class="p">))</span>
|
|
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">add_cog</span><span class="p">(</span><span class="n">Music</span><span class="p">(</span><span class="bp">self</span><span class="p">))</span>
|
|
|
|
<span class="k">async</span> <span class="k">def</span> <span class="nf">on_ready</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
|
<span class="nb">print</span><span class="p">(</span><span class="s2">"I'm online!"</span><span class="p">)</span>
|
|
<span class="k">await</span> <span class="bp">self</span><span class="o">.</span><span class="n">cogs</span><span class="p">[</span><span class="s2">"Music"</span><span class="p">]</span><span class="o">.</span><span class="n">start_nodes</span><span class="p">()</span>
|
|
|
|
|
|
<span class="k">class</span> <span class="nc">Music</span><span class="p">(</span><span class="n">commands</span><span class="o">.</span><span class="n">Cog</span><span class="p">):</span>
|
|
|
|
<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">bot</span><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">bot</span> <span class="o">=</span> <span class="n">bot</span>
|
|
|
|
<span class="bp">self</span><span class="o">.</span><span class="n">pomice</span> <span class="o">=</span> <span class="n">pomice</span><span class="o">.</span><span class="n">NodePool</span><span class="p">()</span>
|
|
|
|
<span class="k">async</span> <span class="k">def</span> <span class="nf">start_nodes</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
|
|
<span class="k">await</span> <span class="bp">self</span><span class="o">.</span><span class="n">pomice</span><span class="o">.</span><span class="n">create_node</span><span class="p">(</span><span class="n">bot</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">bot</span><span class="p">,</span> <span class="n">host</span><span class="o">=</span><span class="s1">'127.0.0.1'</span><span class="p">,</span> <span class="n">port</span><span class="o">=</span><span class="s1">'3030'</span><span class="p">,</span>
|
|
<span class="n">password</span><span class="o">=</span><span class="s1">'youshallnotpass'</span><span class="p">,</span> <span class="n">identifier</span><span class="o">=</span><span class="s1">'MAIN'</span><span class="p">)</span>
|
|
<span class="nb">print</span><span class="p">(</span><span class="sa">f</span><span class="s2">"Node is ready!"</span><span class="p">)</span>
|
|
|
|
|
|
|
|
<span class="nd">@commands</span><span class="o">.</span><span class="n">command</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s1">'join'</span><span class="p">,</span> <span class="n">aliases</span><span class="o">=</span><span class="p">[</span><span class="s1">'connect'</span><span class="p">])</span>
|
|
<span class="k">async</span> <span class="k">def</span> <span class="nf">join</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">ctx</span><span class="p">:</span> <span class="n">commands</span><span class="o">.</span><span class="n">Context</span><span class="p">,</span> <span class="o">*</span><span class="p">,</span> <span class="n">channel</span><span class="p">:</span> <span class="n">discord</span><span class="o">.</span><span class="n">TextChannel</span> <span class="o">=</span> <span class="kc">None</span><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
|
|
|
<span class="k">if</span> <span class="ow">not</span> <span class="n">channel</span><span class="p">:</span>
|
|
<span class="n">channel</span> <span class="o">=</span> <span class="nb">getattr</span><span class="p">(</span><span class="n">ctx</span><span class="o">.</span><span class="n">author</span><span class="o">.</span><span class="n">voice</span><span class="p">,</span> <span class="s1">'channel'</span><span class="p">,</span> <span class="kc">None</span><span class="p">)</span>
|
|
<span class="k">if</span> <span class="ow">not</span> <span class="n">channel</span><span class="p">:</span>
|
|
<span class="k">raise</span> <span class="n">commands</span><span class="o">.</span><span class="n">CheckFailure</span><span class="p">(</span><span class="s1">'You must be in a voice channel to use this command'</span>
|
|
<span class="s1">'without specifying the channel argument.'</span><span class="p">)</span>
|
|
|
|
|
|
<span class="k">await</span> <span class="n">ctx</span><span class="o">.</span><span class="n">author</span><span class="o">.</span><span class="n">voice</span><span class="o">.</span><span class="n">channel</span><span class="o">.</span><span class="n">connect</span><span class="p">(</span><span class="bp">cls</span><span class="o">=</span><span class="n">pomice</span><span class="o">.</span><span class="n">Player</span><span class="p">)</span>
|
|
<span class="k">await</span> <span class="n">ctx</span><span class="o">.</span><span class="n">send</span><span class="p">(</span><span class="sa">f</span><span class="s1">'Joined the voice channel `</span><span class="si">{</span><span class="n">channel</span><span class="si">}</span><span class="s1">`'</span><span class="p">)</span>
|
|
|
|
<span class="nd">@commands</span><span class="o">.</span><span class="n">command</span><span class="p">(</span><span class="n">name</span><span class="o">=</span><span class="s1">'play'</span><span class="p">)</span>
|
|
<span class="k">async</span> <span class="k">def</span> <span class="nf">play</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">ctx</span><span class="p">,</span> <span class="o">*</span><span class="p">,</span> <span class="n">search</span><span class="p">:</span> <span class="nb">str</span><span class="p">)</span> <span class="o">-></span> <span class="kc">None</span><span class="p">:</span>
|
|
|
|
<span class="k">if</span> <span class="ow">not</span> <span class="n">ctx</span><span class="o">.</span><span class="n">voice_client</span><span class="p">:</span>
|
|
<span class="k">await</span> <span class="n">ctx</span><span class="o">.</span><span class="n">invoke</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">join</span><span class="p">)</span>
|
|
|
|
<span class="n">player</span> <span class="o">=</span> <span class="n">ctx</span><span class="o">.</span><span class="n">voice_client</span>
|
|
|
|
<span class="n">results</span> <span class="o">=</span> <span class="k">await</span> <span class="n">player</span><span class="o">.</span><span class="n">get_tracks</span><span class="p">(</span><span class="n">query</span><span class="o">=</span><span class="sa">f</span><span class="s1">'</span><span class="si">{</span><span class="n">search</span><span class="si">}</span><span class="s1">'</span><span class="p">)</span>
|
|
|
|
<span class="k">if</span> <span class="ow">not</span> <span class="n">results</span><span class="p">:</span>
|
|
<span class="k">raise</span> <span class="n">commands</span><span class="o">.</span><span class="n">CommandError</span><span class="p">(</span><span class="s1">'No results were found for that search term.'</span><span class="p">)</span>
|
|
|
|
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">results</span><span class="p">,</span> <span class="n">pomice</span><span class="o">.</span><span class="n">Playlist</span><span class="p">):</span>
|
|
<span class="k">await</span> <span class="n">player</span><span class="o">.</span><span class="n">play</span><span class="p">(</span><span class="n">track</span><span class="o">=</span><span class="n">results</span><span class="o">.</span><span class="n">tracks</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
|
|
<span class="k">else</span><span class="p">:</span>
|
|
<span class="k">await</span> <span class="n">player</span><span class="o">.</span><span class="n">play</span><span class="p">(</span><span class="n">track</span><span class="o">=</span><span class="n">results</span><span class="p">[</span><span class="mi">0</span><span class="p">])</span>
|
|
|
|
|
|
<span class="n">bot</span> <span class="o">=</span> <span class="n">MyBot</span><span class="p">()</span>
|
|
<span class="n">bot</span><span class="o">.</span><span class="n">run</span><span class="p">(</span><span class="s2">"token here"</span><span class="p">)</span>
|
|
</pre></div>
|
|
</div>
|
|
</section>
|
|
</section>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
|
|
<a href="modules.html" class="btn btn-neutral float-right" title="<no title>" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
|
|
</div>
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<p>© Copyright 2021, cloudwithax.</p>
|
|
</div>
|
|
|
|
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
|
|
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
|
|
provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
|
|
|
|
|
</footer>
|
|
</div>
|
|
</div>
|
|
</section>
|
|
</div>
|
|
<script>
|
|
jQuery(function () {
|
|
SphinxRtdTheme.Navigation.enable(true);
|
|
});
|
|
</script>
|
|
|
|
</body>
|
|
</html> |