{"id":16623152,"url":"https://github.com/gazmull/ramiel-bot","last_synced_at":"2025-10-29T22:31:32.691Z","repository":{"id":40750366,"uuid":"173303456","full_name":"gazmull/ramiel-bot","owner":"gazmull","description":"Discord music bot made with discord-akairo and discord.js-lavalink","archived":false,"fork":false,"pushed_at":"2022-08-30T22:32:10.000Z","size":387,"stargazers_count":4,"open_issues_count":6,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-02-02T05:31:33.007Z","etag":null,"topics":["bot","discord","discord-akairo","discord-bot","discord-js","docker-image","javascript","lavalink","mariadb","sequelize-typescript","typescript"],"latest_commit_sha":null,"homepage":"http://erosdev.thegzm.space","language":"TypeScript","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/gazmull.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}},"created_at":"2019-03-01T13:07:37.000Z","updated_at":"2024-04-23T14:25:34.000Z","dependencies_parsed_at":"2023-01-16T16:15:16.922Z","dependency_job_id":null,"html_url":"https://github.com/gazmull/ramiel-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/gazmull%2Framiel-bot","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gazmull%2Framiel-bot/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gazmull%2Framiel-bot/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gazmull%2Framiel-bot/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gazmull","download_url":"https://codeload.github.com/gazmull/ramiel-bot/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238909400,"owners_count":19550839,"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":["bot","discord","discord-akairo","discord-bot","discord-js","docker-image","javascript","lavalink","mariadb","sequelize-typescript","typescript"],"created_at":"2024-10-12T03:22:40.241Z","updated_at":"2025-10-29T22:31:32.342Z","avatar_url":"https://github.com/gazmull.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"![what are you looking at](https://github.com/gazmull/ramiel-bot/blob/master/ramieru.png?raw=true)\n\n![GitHub package.json version](https://img.shields.io/github/package-json/v/gazmull/ramiel-bot.svg?logo=github\u0026style=for-the-badge)\n\n![Travis (.org)](https://img.shields.io/travis/gazmull/ramiel-bot.svg?logo=travis\u0026style=for-the-badge) ![Docker Build Status](https://img.shields.io/docker/cloud/build/gazmull/ramiel-bot.svg?logo=docker\u0026style=for-the-badge\u0026label=Build)\n\n![MicroBadger Size](https://img.shields.io/microbadger/image-size/gazmull/ramiel-bot.svg?style=for-the-badge\u0026logo=Docker\u0026label=Size) ![MicroBadger Layers](https://img.shields.io/microbadger/layers/gazmull/ramiel-bot.svg?style=for-the-badge\u0026logo=Docker\u0026label=Layers) ![Docker Automated build](https://img.shields.io/docker/cloud/automated/gazmull/ramiel-bot.svg?style=for-the-badge\u0026logo=Docker\u0026label=Build) ![Docker Pulls](https://img.shields.io/docker/pulls/gazmull/ramiel-bot.svg?style=for-the-badge\u0026logo=Docker\u0026label=Pulls)\n\n# Ramiel\n- Built with [**Discord.JS-Akairo Framework** (**Master**)](https://github.com/1computer1/discord-akairo) and [**Discord.JS-Lavalink Client**](https://github.com/MrJacz/discord.js-lavalink)\n    - [**Discord.JS-Akairo Documentation**](https://1computer1.github.io/discord-akairo/master)\n    - [**Discord.JS-Lavalink Documentation**](https://mrjacz.github.io/discord.js-lavalink)\n- [**Discord Server**](http://erosdev.thegzm.space)\n- [**Bot Guide**](https://docs.thegzm.space/ramiel-bot) (N/A)\n\n# Features\n- Just a music bot, what else?\n- Currently only supports Youtube search and Direct links.\n\n# Commands\n**Prefix**: `r!` / `ramiel, ` / `@Ramiel`\n\n\u003e See `r!help \u003ccommand\u003e` for a better command description.\n\n\u003e __Not final__.\n\n**Admin**\n- `blacklist` - Blocks/unblocks a user from using Ramiel's commands\n- `moderator` - See or set the current Music Queue Moderator\n\n**General**\n- `help` - Displays reference for Ramiel's commands\n\n**Music**\n- `destroy` - Destroys the player and tells Ramiel to leave the channel\n- `play` - Plays a song or adds a song to the current queue\n- `playlists` - Displays your saved playlists or other user's playlists\n- `pause` - Pauses the current song\n- `queue` - Displays the current queue and the current song playing\n- `save` - Saves the current queue as a playlist to your account\n- `seek` - Seeks to a specified time within the song\n- `stop` - Stops/skips the current song (leaves when there are no songs left in the queue)\n- `volume` - Sets the player volume (Moderators only)\n\n**Utility**\n- `eval` (**bot owner only**) - Evaluates a Javascript syntax text\n- `ping` - Pokes Ramiel\n- `stats` - Displays Ramiel's [technical] information\n\n# Self-Hosting\n\u003e The following items are required: [**Discord Bot Account**](https://github.com/reactiflux/discord-irc/wiki/Creating-a-discord-bot-\u0026-getting-a-token), [**Docker-CE**](https://hub.docker.com/search/?type=edition\u0026offering=community), and at least [**MariaDB 10.1**](https://mariadb.org/)\n\n\u003e This section assumes that the user has basic knowledge of workflow in his/her machine (e.g: how to run a command shell). If not then ask everyone's bestfriend, Google, first.\n\n\u003e **$** denotes it should be executed at a command shell.\n\n## Build from Source\n\n1. `$ git clone https://github.com/gazmull/ramiel-bot.git ramiel \u0026\u0026 cd ramiel`\n2. Create an `auth.js` file and obtain the template from [**auth.example.js**](https://github.com/gazmull/ramiel-bot/blob/master/auth.example.js).\n3. [**Set up MariaDB**](#setting-up-mariadb)\n4. Create an `application.yml` file and obtain the template from [**application.example.yml**](https://github.com/gazmull/ramiel-bot/blob/master/application.example.yml).\n5. Optional: edit `docker-compose.yml` according to preferences, although it is already properly configured.\n   - **!** - To disable automatic updates from [**gazmull/ramiel-bot**](http://dockerhub.com/r/gazmull/ramiel-bot), make sure to put the watchtower service in comments.\n6. `$ docker-compose up -d`\n\n## Pre-built\n\u003e This repository has a pre-built Docker image over here: [**gazmull/ramiel-bot**](http://dockerhub.com/r/gazmull/ramiel-bot)\n\n1. Create a folder named `ramiel` and then do the following in it:\n2. Create an `auth.js` file and obtain the template from [**auth.example.js**](https://github.com/gazmull/ramiel-bot/blob/master/auth.example.js).\n3. [**Set up MariaDB**](#setting-up-mariadb)\n4. Create an `application.yml` file and obtain the template from [**application.example.yml**](https://github.com/gazmull/ramiel-bot/blob/master/application.example.yml).\n5. Edit the `docker-compose.yml` file and obtain the template from [**docker-compose (prebuilt)**](https://gist.github.com/gazmull/1d13c735c86de2598c701968afbc6bcd).\n   - Optional: edit `docker-compose.yml` according to preferences, although it is already properly configured.\n     - **!** - To disable automatic updates from [**gazmull/ramiel-bot**](http://dockerhub.com/r/gazmull/ramiel-bot), make sure to put the watchtower service in comments.\n6. `$ docker-compose up -d`\n\n## Next Step\n\u003e This assumes that the user is in the `ramiel` folder.\n\nHere are some commands to execute while running Ramiel:\n\n- `$ docker-compose stop` to stop all services from `docker-compose.yml`\n- `$ docker-compose logs -f` to see the logs from all services in real time.\n- `$ docker ps -a` to show all containers (services).\n- The following steps are for cleaning up (clean re-installing / uninstalling):\n  1. `$ docker-compose down`\n  2. `$ docker system purge -a`\n\n---\n\n## Setting Up MariaDB\n\u003e To shorten the cover of the guide, please ask Google again on how to install MariaDB. (`how to install MariaDB on [Operating System]` should be enough :angeryCat:)\n\n1. Assuming that the MariaDB server is already installed by this section, open the MariaDB CLI (`$ mysql`), login as root, and then execute each line— replace any text wrapped with `[]` with the credentials from the `auth.js`:\n```sql\nCREATE DATABASE `ramiel` CHARACTER SET = 'utf8mb4' COLLATE = 'utf8mb4_unicode_ci';\nCREATE USER `ramiel`@`localhost` IDENTIFIED BY '[password in auth.js]';\nGRANT ALL PRIVILEGES ON `ramiel`.* TO `ramiel`@`localhost`;\nexit;\n```\n\n# License\n\u003e [**MIT**](https://github.com/gazmull/ramiel-bot/blob/master/LICENSE)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgazmull%2Framiel-bot","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgazmull%2Framiel-bot","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgazmull%2Framiel-bot/lists"}