From 9085adaa98b93a47964d7e8adcd8a5f58dd18fa5 Mon Sep 17 00:00:00 2001
From: MPlaty <contact@mplaty.com>
Date: Sun, 21 Jul 2024 00:06:31 +1000
Subject: [PATCH] add sources.

Added sources. All but youtube links are missing.
---
 docs/api/rest.md    |   1 +
 docs/api/sources.md | 141 ++++++++++++++++++++++++++++++++++++++++++++
 docs/mkdocs.yml     |   1 +
 3 files changed, 143 insertions(+)
 create mode 100644 docs/api/sources.md

diff --git a/docs/api/rest.md b/docs/api/rest.md
index 27daf693..412be633 100644
--- a/docs/api/rest.md
+++ b/docs/api/rest.md
@@ -98,6 +98,7 @@ This endpoint is used to resolve audio tracks for use with the [Update Player](#
 
     Plugins may also implement prefixes to allow for more search engines to be utilised.
 
+    You can find more about sources [here](./sources.md)
 
 ```
 GET /v4/loadtracks?identifier=dQw4w9WgXcQ
diff --git a/docs/api/sources.md b/docs/api/sources.md
new file mode 100644
index 00000000..738176c1
--- /dev/null
+++ b/docs/api/sources.md
@@ -0,0 +1,141 @@
+---
+description: Lavalink Sources API documentation.
+---
+
+# Sources
+
+Below is all the default sources that come with Lavalink. Make sure to have them enabled!
+
+## YouTube
+
+!!! note
+    Make sure you have the YouTube plugin added!
+
+    You can find it [here](https://github.com/lavalink-devs/youtube-source).
+
+Enabling this option:
+
+```yml title="application.yml"
+server:
+    sources:
+        youtube: true
+```
+
+### Searching {: #youtube-searching }
+
+Searching using Youtube.
+
+ - `ytsearch`: This will search `youtube.com` for relevant tracks/playlists.
+ - `ytmsearch`: This will search `music.youtube.com` for relevant tracks/playlists.
+
+### URLs {: #youtube-url }
+
+Supported URL types
+
+ - https://youtube.com/watch?v=dQw4w9WgXcQ
+ - https://youtube.com/playlist?list=PLlaN88a7y2_qSLH3pLiQIQ6isY_DZTtdg
+ - https://youtube.com/shorts/dQw4w9WgXcQ
+ - https://youtube.com/live/dQw4w9WgXcQ
+ - https://youtube.com/embed/dQw4w9WgXcQ
+ - https://www.youtube.com/watch?v=dQw4w9WgXcQ
+ - https://www.youtube.com/playlist?list=PLlaN88a7y2_qSLH3pLiQIQ6isY_DZTtdg
+ - https://www.youtube.com/shorts/dQw4w9WgXcQ
+ - https://www.youtube.com/live/dQw4w9WgXcQ
+ - https://www.youtube.com/embed/dQw4w9WgXcQ
+ - https://youtu.be/watch?v=dQw4w9WgXcQ
+ - https://youtu.be/playlist?list=PLlaN88a7y2_qSLH3pLiQIQ6isY_DZTtdg
+ - https://music.youtube.com/watch?v=dQw4w9WgXcQ
+ - https://music.youtube.com/playlist?list=PLlaN88a7y2_qSLH3pLiQIQ6isY_DZTtdg
+ - https://music.youtube.com/embed/dQw4w9WgXcQ
+
+## Bandcamp
+
+Enabling this option:
+
+```yml title="application.yml"
+server:
+    sources:
+        bandcamp: true
+```
+
+### Searching {: #bandcamp-searching }
+
+Searching using Bandcamp.
+
+ - `bcsearch`: This will search `bandcamp.com` for relevant tracks/playlists.
+
+### URLs {: #bandcamp-url }
+
+Supported URL types
+
+ - FIXME: add url's
+
+## SoundCloud
+
+Enabling this option:
+
+```yml title="application.yml"
+server:
+    sources:
+        soundcloud: true
+```
+
+### Searching {: #soundcloud-searching }
+
+Searching using SoundCloud.
+
+ - `scsearch`: This will search `soundcloud.com` for relevant tracks/playlists.
+
+### URLs {: #soundcloud-url }
+
+Supported URL types
+
+ - FIXME: add url's
+
+## Twitch
+
+Enabling this option:
+
+```yml title="application.yml"
+server:
+    sources:
+        twitch: true
+```
+
+### URLs {: #twitch-url }
+
+Supported URL types
+
+ - FIXME: add url's
+
+## Vimeo
+
+Enabling this option:
+
+```yml title="application.yml"
+server:
+    sources:
+        vimeo: true
+```
+
+### URLs {: #vimeo-url }
+
+Supported URL types
+
+ - FIXME: add url's
+
+## Nico
+
+Enabling this option:
+
+```yml title="application.yml"
+server:
+    sources:
+        nico: true
+```
+
+### URLs {: #nico-url }
+
+Supported URL types
+
+ - FIXME: add url's
diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
index ba2e5d41..9dc4aa0b 100644
--- a/docs/mkdocs.yml
+++ b/docs/mkdocs.yml
@@ -39,6 +39,7 @@ nav:
       - Websocket: api/websocket.md
       - Rest: api/rest.md
       - Plugins: api/plugins.md
+      - Sources: api/sources.md
   - Changelog:
       - changelog/index.md
       - v4: changelog/v4.md