Move songbird and examples relying on it to the new repository (#1077)

.github/workflows/ci.yml

@@ -160,37 +160,25 @@ jobs:
         run: cargo build -p e05_command_framework
       - name: 'Build example 6'
         working-directory: examples
-        run: cargo build -p e06_voice
+        run: cargo build -p e06_sample_bot_structure
       - name: 'Build example 7'
         working-directory: examples
-        run: cargo build -p e07_sample_bot_structure
+        run: cargo build -p e07_env_logging
       - name: 'Build example 8'
         working-directory: examples
-        run: cargo build -p e08_env_logging
+        run: cargo build -p e08_shard_manager
       - name: 'Build example 9'
         working-directory: examples
-        run: cargo build -p e09_shard_manager
+        run: cargo build -p e09_create_message_builder
       - name: 'Build example 10'
         working-directory: examples
-        run: cargo build -p e10_voice_receive
+        run: cargo build -p e10_collectors
       - name: 'Build example 11'
         working-directory: examples
-        run: cargo build -p e11_create_message_builder
+        run: cargo build -p e11_gateway_intents
       - name: 'Build example 12'
         working-directory: examples
-        run: cargo build -p e12_collectors
+        run: cargo build -p e12_global_data
       - name: 'Build example 13'
         working-directory: examples
-        run: cargo build -p e13_gateway_intents
-      - name: 'Build example 14'
-        working-directory: examples
-        run: cargo build -p e14_global_data
-      - name: 'Build example 15'
-        working-directory: examples
-        run: cargo build -p e15_parallel_loops
-      - name: 'Build example 16'
-        working-directory: examples
-        run: cargo build -p e16_voice_events_queue
-      - name: 'Build example 17'
-        working-directory: examples
-        run: cargo build -p e17_voice_storage
+        run: cargo build -p e13_parallel_loops

README.md

@@ -140,8 +140,8 @@ enough level that optional parameters can be provided at will via a JsonMap.
 the HTTP functions.
 - **standard_framework**: A standard, default implementation of the Framework
 - **utils**: Utility functions for common use cases by users.
-- **voice**: Enables compilation of voice support, so that voice channels can be
-connected to and audio can be sent/received.
+- **voice**: Enables registering a voice plugin to the client, which will handle actual voice connections from Discord.
+[lavalink-rs][project:lavalink-rs] or [Songbird][project:songbird] are recommended voice plugins.
 - **default_native_tls**: Default features but using `native_tls_backend`
 instead of `rustls_backend`.
 - **absolute_ratelimits**: Whether the library should use your system clock to avoid
@@ -184,24 +184,10 @@ If you use the `native_tls_backend` and you are not developing on macOS or Windo
 
 - openssl
 
-If you want to use `voice`, Serenity will attempt to build these for you:
-
-- libsodium (Arch: `community/libsodium`)
-- opus (Arch: `extra/opus`)
-
-In case the automated building fails, you may report it to us, but installing should fix it.
-
-Voice + ffmpeg:
-
-- ffmpeg (Arch: `extra/ffmpeg`)
-
-Voice + youtube-dl:
-
-- youtube-dl (Arch: `community/youtube-dl`)
-
 # Projects extending Serenity
 
 - [lavalink-rs][project:lavalink-rs]: An interface to [Lavalink][repo:lavalink], an audio sending node based on [Lavaplayer][repo:lavaplayer]
+- [Songbird][project:songbird]: An async Rust library for the Discord voice API.
 
 [`Cache`]: https://docs.rs/serenity/*/serenity/cache/struct.Cache.html
 [`Client::builder`]: https://docs.rs/serenity/*/serenity/client/struct.Client.html#method.builder
@@ -227,6 +213,7 @@ Voice + youtube-dl:
 [guild]: https://discord.gg/9X7vCus
 [guild-badge]: https://img.shields.io/discord/381880193251409931.svg?style=flat-square&colorB=7289DA
 [project:lavalink-rs]: https://gitlab.com/nitsuga5124/lavalink-rs/
+[project:songbird]: https://github.com/serenity-rs/songbird
 [repo:lavalink]: https://github.com/Frederikam/Lavalink
 [repo:lavaplayer]: https://github.com/sedmelluq/lavaplayer
 [logo]: https://raw.githubusercontent.com/serenity-rs/serenity/current/logo.png

examples/Cargo.toml

@@ -5,16 +5,12 @@ members = [
     "e03_struct_utilities",
     "e04_message_builder",
     "e05_command_framework",
-    "e06_voice",
-    "e07_sample_bot_structure",
-    "e08_env_logging",
-    "e09_shard_manager",
-    "e10_voice_receive",
-    "e11_create_message_builder",
-    "e12_collectors",
-    "e13_gateway_intents",
-    "e14_global_data",
-    "e15_parallel_loops",
-    "e16_voice_events_queue",
-    "e17_voice_storage",
+    "e06_sample_bot_structure",
+    "e07_env_logging",
+    "e08_shard_manager",
+    "e09_create_message_builder",
+    "e10_collectors",
+    "e11_gateway_intents",
+    "e12_global_data",
+    "e13_parallel_loops",
 ]

examples/e07_sample_bot_structure/Cargo.toml → examples/e06_sample_bot_structure/Cargo.toml

@@ -1,5 +1,5 @@
 [package]
-name = "e07_sample_bot_structure"
+name = "e06_sample_bot_structure"
 version = "0.1.0"
 authors = ["my name <my@email.address>"]
 edition = "2018"