Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/abdulrahman1s/quran-bot
☪️ A Discord bot that can play Qur'an recitations in voice chat.
https://github.com/abdulrahman1s/quran-bot
bot discord discordbot discordjs islam muslim quran
Last synced: 10 days ago
JSON representation
☪️ A Discord bot that can play Qur'an recitations in voice chat.
- Host: GitHub
- URL: https://github.com/abdulrahman1s/quran-bot
- Owner: abdulrahman1s
- License: unlicense
- Created: 2021-06-28T05:58:40.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2022-08-17T23:04:26.000Z (over 2 years ago)
- Last Synced: 2024-11-05T22:46:04.287Z (about 2 months ago)
- Topics: bot, discord, discordbot, discordjs, islam, muslim, quran
- Language: TypeScript
- Homepage:
- Size: 48.8 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://heroku.com/deploy?template=https://github.com/TheMaestro1s/quran-bot)
# Quran bot
A simple bot that can play recitations of surahs, ayahs and mushaf pages from the Qur'an in voice chat, along with a live audio stream from Makkah. It currently supports 120+ reciters.
## 📌 Features
- Plays *ayah*, *surah* and *page* (`/play`)
- Supports 120+ reciters
- Accepts arabic reciter names (thanks to [arabic2franko](https://github.com/ahmadfathy97/arabic2franko))
- Islamic prayertimes (`/prayertimes`)
- Reading the quran (`/mushaf`)
- Live quran radio (`/live`)
- Check out `/help` command to see the full list!
## 🪄 Easy Deploy
- [Heroku](https://heroku.com/deploy?template=https://github.com/TheMaestro1s/quran-bot)
- Replit (Soon)
## ⚙️ Setup (Advanced)
1. Download the [zip](https://github.com/TheMaestro1s/quran-bot.git) file and extract it
2. Go inside `quran-bot` folder
3. Create a file named `.env` or rename `.env.example`
4. Put the following to `.env` file:
```
DISCORD_TOKEN=your-discord-token-here
```
4. Open the terminal and do the following:
```bash
$ npm install
$ npm start
```
5. That's it! open an [issue](https://github.com/TheMaestro1s/quran-bot/issues) if you need help!
## 🔌 Sources
- [mp3quran.net](http://mp3quran.net/) for the surah recitations, ayah recitations and Qur'an radio.
- [everyayah.com](https://everyayah.com/) for the page recitations.
- [haramain.info](http://www.haramain.info/) for the live Makkah audio.
### 📝 License
Refer to the [LICENSE](LICENSE) file.