{"id":13624504,"url":"https://github.com/aquelemiguel/parrot","last_synced_at":"2025-04-16T00:32:32.284Z","repository":{"id":39642627,"uuid":"406963143","full_name":"aquelemiguel/parrot","owner":"aquelemiguel","description":"🦜 A hassle-free, highly performant, self-hosted Discord music bot with YouTube and Spotify support. Powered by yt-dlp.","archived":false,"fork":false,"pushed_at":"2024-07-12T10:56:59.000Z","size":354,"stargazers_count":133,"open_issues_count":14,"forks_count":42,"subscribers_count":10,"default_branch":"main","last_synced_at":"2024-08-01T22:00:30.708Z","etag":null,"topics":["discord","hacktoberfest","music-bot","rust","serenity-rs","songbird-rs","youtube-dl","yt-dlp"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/aquelemiguel.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-09-16T00:25:09.000Z","updated_at":"2024-08-01T17:17:16.000Z","dependencies_parsed_at":"2024-02-28T14:47:16.369Z","dependency_job_id":"e0d6ee7c-5afa-4b14-a8e7-35e1c0baeb30","html_url":"https://github.com/aquelemiguel/parrot","commit_stats":null,"previous_names":[],"tags_count":18,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aquelemiguel%2Fparrot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aquelemiguel%2Fparrot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aquelemiguel%2Fparrot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/aquelemiguel%2Fparrot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/aquelemiguel","download_url":"https://codeload.github.com/aquelemiguel/parrot/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223691630,"owners_count":17186859,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["discord","hacktoberfest","music-bot","rust","serenity-rs","songbird-rs","youtube-dl","yt-dlp"],"created_at":"2024-08-01T21:01:43.241Z","updated_at":"2024-11-08T13:30:36.918Z","avatar_url":"https://github.com/aquelemiguel.png","language":"Rust","funding_links":[],"categories":["Rust"],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg alt=\"Light\" src=\"./docs/logo.png\" width=\"50%\"\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  A hassle-free, highly performant, host-it-yourself Discord music bot\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/aquelemiguel/parrot/actions/workflows/ci_workflow.yml\"\u003e\u003cimg src=\"https://github.com/aquelemiguel/parrot/actions/workflows/ci_workflow.yml/badge.svg\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://deps.rs/repo/github/aquelemiguel/parrot\"\u003e\u003cimg src=\"https://deps.rs/repo/github/aquelemiguel/parrot/status.svg\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://github.com/aquelemiguel/parrot/blob/main/LICENSE\"\u003e\u003cimg src=\"https://img.shields.io/badge/license-MIT-blue.svg\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://github.com/aquelemiguel/parrot/\"\u003e\u003cimg src=\"https://img.shields.io/badge/rustc-1.65-blue.svg\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n## Deployment\n\n### Usage\n\nJust [create a bot account](https://github.com/aquelemiguel/parrot/wiki/Create-Your-Discord-Bot), and copy its **token** and **application id** to a `.env` with the `DISCORD_TOKEN` and `DISCORD_APP_ID` environment variables respectively. Optionally, you may also define `SPOTIFY_CLIENT_ID` and `SPOTIFY_CLIENT_SECRET`. We recommend using our [.env.example](https://github.com/aquelemiguel/parrot/blob/main/.env.example) as a starting point.\n\n### Docker\n\n```shell\ndocker run -d --env-file .env --restart unless-stopped --name parrot ghcr.io/aquelemiguel/parrot:latest\n```\n\n## Development\n\nMake sure you've installed Rust. You can install Rust and its package manager, `cargo` by following the instructions on https://rustup.rs/.\nAfter installing the requirements below, simply run `cargo run`.\n\n### Linux/MacOS\n\nThe commands below install a C compiler, GNU autotools and FFmpeg, as well as [yt-dlp](https://github.com/yt-dlp/yt-dlp) through Python's package manager, pip.\n\n#### Linux\n\n```shell\napt install build-essential autoconf automake libtool ffmpeg\npip install -U yt-dlp\n```\n\n#### MacOS\n\n```shell\nbrew install autoconf automake libtool ffmpeg\npip install -U yt-dlp\n```\n\n### Windows\n\nIf you are using the MSVC toolchain, a prebuilt DLL for Opus is already provided for you.  \nYou will only need to download [FFmpeg](https://ffmpeg.org/download.html), and install [yt-dlp](https://github.com/yt-dlp/yt-dlp) which can be done through Python's package manager, pip.\n\n```shell\npip install -U yt-dlp\n```\n\nIf you are using Windows Subsystem for Linux (WSL), you should follow the [Linux/MacOS](#linuxmacos) guide, and, in addition to the other required packages, install pkg-config, which you may do by running:\n\n```shell\napt install pkg-config\n```\n\n## Testing\n\nTests are available inside the `src/tests` folder. They can be run via `cargo test`. It's recommended that you run the tests before submitting your Pull Request.\nIncreasing the test coverage is also welcome.\n\n### Docker\n\nWithin the project folder, simply run the following:\n\n```shell\ndocker build -t parrot .\ndocker run -d --env-file .env parrot\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faquelemiguel%2Fparrot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Faquelemiguel%2Fparrot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Faquelemiguel%2Fparrot/lists"}