{"id":24383613,"url":"https://github.com/minidomo/mini-bot","last_synced_at":"2025-03-12T17:21:27.725Z","repository":{"id":40742216,"uuid":"163861766","full_name":"minidomo/Mini-Bot","owner":"minidomo","description":"A Discord music bot for my friend's server.","archived":false,"fork":false,"pushed_at":"2022-07-07T11:00:29.000Z","size":315,"stargazers_count":0,"open_issues_count":6,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-01-19T10:14:57.428Z","etag":null,"topics":["discord-bot"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/minidomo.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-01-02T16:02:17.000Z","updated_at":"2020-09-21T05:32:30.000Z","dependencies_parsed_at":"2022-09-13T08:31:07.342Z","dependency_job_id":null,"html_url":"https://github.com/minidomo/Mini-Bot","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/minidomo%2FMini-Bot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/minidomo%2FMini-Bot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/minidomo%2FMini-Bot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/minidomo%2FMini-Bot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/minidomo","download_url":"https://codeload.github.com/minidomo/Mini-Bot/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243259100,"owners_count":20262403,"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-bot"],"created_at":"2025-01-19T10:15:12.353Z","updated_at":"2025-03-12T17:21:27.693Z","avatar_url":"https://github.com/minidomo.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Mini Bot\nMini Bot is a music bot that features playlists. Users can create playlists through this bot and can be saved and played at any time.\n\n**Previous Versions**  \nPrevious versions of Mini Bot are no longer being developed or maintained.\n- [2.0.0](https://github.com/MiniDomo/Mini-Bot/tree/2.0.0)\n- [1.0.0](https://github.com/MiniDomo/Mini-Bot/tree/1.0.0)\n\n## Installation\nType the following in command prompt:\n```shell\ngit clone https://github.com/minidomo/Mini-Bot.git\ncd Mini-Bot\nnpm install\n```\n\n## Setup\nThis bot requires the use of [FFmpeg](https://ffmpeg.org). Install this to proceed.\n1. Rename `.env.example` to `.env`\n2. Put your bot's token after `PROD_BOT_TOKEN=`\n    - If you have another bot that is dedicated to testing a bot's code before going to production, you can provide its token in the `.env` like so: `TEST_BOT_TOKEN=\u003ctoken\u003e` and type `npm run start` in command line to run with the `TEST_BOT_TOKEN`.\n3. Provide your Discord user ID after `OWNER_ID=` which can be obtained by typing `\\@\u003cyour discord username\u003e` in a Discord text channel. The **numbers** between \u003c and \u003e represent your Discord user ID.\n4. If you have a [YouTube v3 API Key](https://console.developers.google.com/apis/credentials) and would like to use it for faster searches, then you can place it after `YOUTUBE_API_KEY=`\n\n## Scripts\nTo run the scripts, type the following in command prompt:\n```shell\nnpm run \u003cscript name\u003e\n```\n\n| Name | Description |\n| - | - |\n| `build` | Compiles the `src` folder and generates JavaScript files in the generated `dist` folder. |\n| `start` | Runs the `build` script and starts the bot using the `TEST_BOT_TOKEN` |\n| `start:prod` | Runs the `build` script and start the bot using the `PROD_BOT_TOKEN` |\n| `clean` | Deletes the `dist` folder. |\n\n## Bot Arguments\nThe scripts `start` and `start:prod` start the bot and pass arguments to enable/disable some functionalities.\n\n| Name | Description |\n| - | - |\n| `-p`/`--prod` | Indicates that the bot will use the `PROD_BOT_TOKEN`. |\n| `-sm`/`--saveMp3` | When the bot plays a new song, it will download the mp3 and save it to the folder `.\\save\\songs`. This can help with consistent playback. |\n| `-ssc`/`--saveSongCache` | When a song is added the queue or a playlist, it's title, Youtube ID, duration, and channel is stored in memory. With this option turned on, it will save this information in `.\\save\\songcache.json` and can be used the next time the bot runs. This can be useful for when there are repeated searches for a song in which it will add to the queue or playlist much faster.\n| `-d`/`--debug` | Prints out debug information to the console. |","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fminidomo%2Fmini-bot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fminidomo%2Fmini-bot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fminidomo%2Fmini-bot/lists"}