-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathindex.html
310 lines (308 loc) · 18.5 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>FastLink: Fastlink</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="doxygen-awesome.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr id="projectrow">
<td id="projectalign">
<div id="projectname">FastLink<span id="projectnumber"> 2.3.5</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div><div class="header">
<div class="headertitle"><div class="title">Fastlink </div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p ><a class="anchor" id="md_README"></a> <a href="https://bestpractices.coreinfrastructure.org/projects/5944"><img src="https://bestpractices.coreinfrastructure.org/projects/5944/badge" alt="CII Best Practices" class="inline"/></a> <a href="https://discord.gg/uPveNfTuCJ"><img src="https://img.shields.io/discord/1036045973039890522?color=5865F2&logo=discord&logoColor=white" alt="Discord Server" class="inline"/></a> <a href="https://packagephobia.now.sh/result?p=@performanc/fastlink"><img src="https://packagephobia.now.sh/badge?p=@performanc/fastlink" alt="FastLink package size" class="inline"/></a></p>
<h1><a class="anchor" id="autotoc_md1"></a>
About</h1>
<p >FastLink is a low-level <a href="https://nodejs.org">Node.js</a> Lavalink client, with a simple and easy-to-use API. It is made to be fast and lightweight.</p>
<h1><a class="anchor" id="autotoc_md2"></a>
Installation</h1>
<p >FastLink is both available on <a href="https://npmjs.com">npm</a> and GitHub Packages. Here's how to install it from npm:</p>
<div class="fragment"><div class="line">$ npm i @performanc/fastlink</div>
</div><!-- fragment --><h1><a class="anchor" id="autotoc_md3"></a>
Usage</h1>
<h2><a class="anchor" id="autotoc_md4"></a>
Minimum requirements</h2>
<ul>
<li>Node.js 14 or higher</li>
<li>Lavalink v4</li>
</ul>
<h2><a class="anchor" id="autotoc_md5"></a>
Recommended requirements</h2>
<ul>
<li>NodeJs 18 or higher</li>
<li>NodeLink</li>
</ul>
<h2><a class="anchor" id="autotoc_md6"></a>
Example</h2>
<div class="fragment"><div class="line"><span class="keyword">import</span> FastLink from <span class="stringliteral">'@performanc/fastlink'</span></div>
<div class="line"><span class="keyword">import</span> Discord from <span class="stringliteral">'discord.js'</span></div>
<div class="line"> </div>
<div class="line"><span class="keyword">const</span> client = <span class="keyword">new</span> Discord.Client({</div>
<div class="line"> partials: [</div>
<div class="line"> Discord.Partials.Channel</div>
<div class="line"> ],</div>
<div class="line"> intents: [</div>
<div class="line"> Discord.IntentsBitField.Flags.Guilds,</div>
<div class="line"> Discord.IntentsBitField.Flags.MessageContent,</div>
<div class="line"> Discord.IntentsBitField.Flags.GuildMessages,</div>
<div class="line"> Discord.IntentsBitField.Flags.GuildVoiceStates</div>
<div class="line"> ]</div>
<div class="line">})</div>
<div class="line"> </div>
<div class="line"><span class="keyword">const</span> prefix = <span class="charliteral">'!'</span></div>
<div class="line"><span class="keyword">const</span> botId = <span class="stringliteral">'Your bot Id here'</span></div>
<div class="line"><span class="keyword">const</span> token = <span class="stringliteral">'Your bot token here'</span></div>
<div class="line"> </div>
<div class="line"><span class="keyword">const</span> events = FastLink.node.connectNodes([{</div>
<div class="line"> hostname: <span class="stringliteral">'127.0.0.1'</span>,</div>
<div class="line"> secure: false,</div>
<div class="line"> password: <span class="stringliteral">'youshallnotpass'</span>,</div>
<div class="line"> port: 2333</div>
<div class="line">}], {</div>
<div class="line"> botId,</div>
<div class="line"> shards: 1,</div>
<div class="line"> queue: true</div>
<div class="line">})</div>
<div class="line"> </div>
<div class="line">events.on(<span class="stringliteral">'debug'</span>, console.log)</div>
<div class="line"> </div>
<div class="line">client.on(<span class="stringliteral">'messageCreate'</span>, async (message) => {</div>
<div class="line"> <span class="keywordflow">if</span> (message.author.bot) <span class="keywordflow">return</span>;</div>
<div class="line"> </div>
<div class="line"> <span class="keyword">const</span> commandName = message.content.split(<span class="charliteral">' '</span>)[0].toLowerCase().substring(prefix.length)</div>
<div class="line"> <span class="keyword">const</span> args = message.content.split(<span class="charliteral">' '</span>).slice(1).join(<span class="charliteral">' '</span>)</div>
<div class="line"> </div>
<div class="line"> if (commandName == <span class="stringliteral">'decodetrack'</span>) {</div>
<div class="line"> <span class="keyword">const</span> player = <span class="keyword">new</span> FastLink.player.Player(message.guild.id)</div>
<div class="line"> </div>
<div class="line"> if (player.playerCreated() == <span class="keyword">false</span>) {</div>
<div class="line"> message.channel.send(<span class="stringliteral">'No player found.'</span>)</div>
<div class="line"> </div>
<div class="line"> return;</div>
<div class="line"> }</div>
<div class="line"> </div>
<div class="line"> <span class="keyword">const</span> track = await player.decodeTrack(args)</div>
<div class="line"> </div>
<div class="line"> message.channel.send(JSON.stringify(track, <span class="keyword">null</span>, 2))</div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">return</span>;</div>
<div class="line"> }</div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">if</span> (commandName == <span class="stringliteral">'play'</span>) {</div>
<div class="line"> <span class="keywordflow">if</span> (!message.member.voice.channel) {</div>
<div class="line"> message.channel.send(<span class="stringliteral">'You must be in a voice channel.'</span>)</div>
<div class="line"> </div>
<div class="line"> return;</div>
<div class="line"> }</div>
<div class="line"> </div>
<div class="line"> if (!FastLink.node.anyNodeAvailable()) {</div>
<div class="line"> message.channel.send(<span class="stringliteral">'There aren\'t nodes connected.'</span>)</div>
<div class="line"> </div>
<div class="line"> return;</div>
<div class="line"> }</div>
<div class="line"> </div>
<div class="line"> <span class="keyword">const</span> player = <span class="keyword">new</span> FastLink.player.Player(message.guild.id)</div>
<div class="line"> </div>
<div class="line"> if (player.playerCreated() == <span class="keyword">false</span>) player.createPlayer()</div>
<div class="line"> </div>
<div class="line"> player.connect(message.member.voice.channel.id.toString(), { mute: false, deaf: true }, (guildId, payload) => {</div>
<div class="line"> client.guilds.cache.get(guildId).shard.send(payload)</div>
<div class="line"> })</div>
<div class="line"> </div>
<div class="line"> <span class="keyword">const</span> track = await player.loadTrack((args.startsWith(<span class="stringliteral">'https://'</span>) ? <span class="stringliteral">''</span> : <span class="stringliteral">'ytsearch:'</span>) + args)</div>
<div class="line"> </div>
<div class="line"> if (track.loadType == <span class="stringliteral">'error'</span>) {</div>
<div class="line"> message.channel.send(<span class="stringliteral">'Something went wrong. '</span> + track.data.message)</div>
<div class="line"> </div>
<div class="line"> return;</div>
<div class="line"> }</div>
<div class="line"> </div>
<div class="line"> if (track.loadType == <span class="stringliteral">'empty'</span>) {</div>
<div class="line"> message.channel.send(<span class="stringliteral">'No matches found.'</span>)</div>
<div class="line"> </div>
<div class="line"> return;</div>
<div class="line"> }</div>
<div class="line"> </div>
<div class="line"> if (track.loadType == <span class="stringliteral">'playlist'</span>) {</div>
<div class="line"> player.update({ encodedTracks: track.data.tracks.map((track) => track.encoded) })</div>
<div class="line"> </div>
<div class="line"> message.channel.send(`Added ${track.data.tracks.length} songs to the queue, and playing ${track.data.tracks[0].info.title}.`)</div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">return</span>;</div>
<div class="line"> }</div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">if</span> (track.loadType == <span class="stringliteral">'track'</span> || track.loadType == <span class="stringliteral">'short'</span>) {</div>
<div class="line"> player.update({ encodedTrack: track.data.encoded, })</div>
<div class="line"> </div>
<div class="line"> message.channel.send(`Playing ${track.data.info.title} from ${track.data.info.sourceName} from url search.`)</div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">return</span>;</div>
<div class="line"> }</div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">if</span> (track.loadType == <span class="stringliteral">'search'</span>) {</div>
<div class="line"> player.update({ encodedTrack: track.data[0].encoded })</div>
<div class="line"> </div>
<div class="line"> message.channel.send(`Playing ${track.data[0].info.title} from ${track.data[0].info.sourceName} from search.`)</div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">return</span>;</div>
<div class="line"> }</div>
<div class="line"> }</div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">if</span> (commandName == <span class="stringliteral">'volume'</span>) {</div>
<div class="line"> <span class="keyword">const</span> player = <span class="keyword">new</span> FastLink.player.Player(message.guild.id)</div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">if</span> (player.playerCreated() == <span class="keyword">false</span>) {</div>
<div class="line"> message.channel.send(<span class="stringliteral">'No player found.'</span>)</div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">return</span>;</div>
<div class="line"> }</div>
<div class="line"> </div>
<div class="line"> player.update({</div>
<div class="line"> volume: parseInt(args)</div>
<div class="line"> })</div>
<div class="line"> </div>
<div class="line"> message.channel.send(`Volume <span class="keyword">set</span> to ${parseInt(args)}`)</div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">return</span>;</div>
<div class="line"> }</div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">if</span> (commandName == <span class="stringliteral">'pause'</span>) {</div>
<div class="line"> <span class="keyword">const</span> player = <span class="keyword">new</span> FastLink.player.Player(message.guild.id)</div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">if</span> (player.playerCreated() == <span class="keyword">false</span>) {</div>
<div class="line"> message.channel.send(<span class="stringliteral">'No player found.'</span>)</div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">return</span>;</div>
<div class="line"> }</div>
<div class="line"> </div>
<div class="line"> player.update({ paused: <span class="keyword">true</span> })</div>
<div class="line"> </div>
<div class="line"> message.channel.send(<span class="stringliteral">'Paused.'</span>)</div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">return</span>;</div>
<div class="line"> }</div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">if</span> (commandName == <span class="stringliteral">'resume'</span>) {</div>
<div class="line"> <span class="keyword">const</span> player = <span class="keyword">new</span> FastLink.player.Player(message.guild.id)</div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">if</span> (player.playerCreated() == <span class="keyword">false</span>) {</div>
<div class="line"> message.channel.send(<span class="stringliteral">'No player found.'</span>)</div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">return</span>;</div>
<div class="line"> }</div>
<div class="line"> </div>
<div class="line"> player.update({ paused: <span class="keyword">false</span> })</div>
<div class="line"> </div>
<div class="line"> message.channel.send(<span class="stringliteral">'Resumed.'</span>)</div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">return</span>;</div>
<div class="line"> }</div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">if</span> (commandName == <span class="stringliteral">'skip'</span>) {</div>
<div class="line"> <span class="keyword">const</span> player = <span class="keyword">new</span> FastLink.player.Player(message.guild.id)</div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">if</span> (player.playerCreated() == <span class="keyword">false</span>) {</div>
<div class="line"> message.channel.send(<span class="stringliteral">'No player found.'</span>)</div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">return</span>;</div>
<div class="line"> }</div>
<div class="line"> </div>
<div class="line"> <span class="keyword">const</span> skip = player.skipTrack()</div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">if</span> (skip) message.channel.send(<span class="stringliteral">'Skipped the current track.'</span>)</div>
<div class="line"> <span class="keywordflow">else</span> message.channel.send(<span class="stringliteral">'Could not skip the current track.'</span>)</div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">return</span>;</div>
<div class="line"> }</div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">if</span> (commandName == <span class="stringliteral">'stop'</span>) {</div>
<div class="line"> <span class="keyword">const</span> player = <span class="keyword">new</span> FastLink.player.Player(message.guild.id)</div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">if</span> (player.playerCreated() == <span class="keyword">false</span>) {</div>
<div class="line"> message.channel.send(<span class="stringliteral">'No player found.'</span>)</div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">return</span>;</div>
<div class="line"> }</div>
<div class="line"> </div>
<div class="line"> player.update({ encodedTrack: <span class="keyword">null</span> })</div>
<div class="line"> </div>
<div class="line"> message.channel.send(<span class="stringliteral">'Stopped the player.'</span>)</div>
<div class="line"> </div>
<div class="line"> <span class="keywordflow">return</span>;</div>
<div class="line"> }</div>
<div class="line">})</div>
<div class="line"> </div>
<div class="line">client.on(<span class="stringliteral">'raw'</span>, (data) => FastLink.other.handleRaw(data))</div>
<div class="line"> </div>
<div class="line">client.login(token)</div>
</div><!-- fragment --><h1><a class="anchor" id="autotoc_md7"></a>
Documentation</h1>
<p >We have a documentation for FastLink, you can find it <a href="https://performanc.github.io/FastLinkDocs/">here</a>. If you have any issue with it, please report it on GitHub Issues.</p>
<h1><a class="anchor" id="autotoc_md8"></a>
Support & Feedback</h1>
<p >If you have any questions, or only want to give a feedback, about FastLink or any other PerformanC project, join <a href="https://discord.gg/uPveNfTuCJ">our Discord server</a>.</p>
<h1><a class="anchor" id="autotoc_md9"></a>
License</h1>
<p >FastLink is licensed under PerformanC's License, which is a modified version of the MIT License, focusing on the protection of the source code and the rights of the PerformanC team over the source code. </p>
</div></div><!-- PageDoc -->
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>