4i8 / QuranBot

Quran bot. To play surahs from the Holy Quran in audio channels and remind prayer times with the support of many cities.

Go to Arabic Version || الذهاب لنسخة العربية

Considering

• The community can contribute to making improvements and adding new features.
• The project is not for profit ⚠
  • It is never allowed to sell this bot and you will be legally prosecuted.

Installation

1. Clone QuranBot with git clone

   	git clone https://github.com/4i8/quranbot.git
   	cd quranbot

2. Install Packages

   	npm install

Rename src/config.example.json to src/config.json

3. Add your Tokens to src/config.json

   {
   	"BOT_TOKEN": "<REQUIRD>",
   	"TEST_BOT_TOKEN": "<REQUIRD>",
   	"Mongo_DB": "<REQUIRD>"
   }

Run Locally

	npm run start

Commands List

Command	Description	Usage | Examples	Additional
/play	Play The Quran in a voice channel with more than 130 Reader[Reciter]	/play "Ahmad Al-Hawashi" Al-Baqara	It supports the search feature so that you write the name of the surah, the reciter, the surah number, or the reciter’s number, and it will give you options
/pause	Pause the Recitation.	/pause
/resume	Resume the Recitation.	/resume
/volume	Adjust the volume with range (10-150)	/volume 55 /volume 88
/nowplaying	Display information about what is playing now.	/nowplaying
/queue	Display the queue	/queue
/loop	Toggle the loop mode (On/Off)	/loop
/seek	Jump to a specific time in a play track.	/seek 2:30:10
/skip	Skip to the next item in the queue	/skip
/stop	Clear the queue and stops the Recitation.	/stop
/qasas	Plays the stories of the prophets.	/qasas ما قبل خلق آدم عليه السلام	The voice of Nabil Al-Awadi and Tariq Al-Suwaidan in high quality
/quran	Display and Browse the Pages of the Holy Quran.	/quran <surah|page>
/azkar	Adjust the Azkar system settings.	/azkar	Azkar system: sends Azkar in text channel once in while.
/khutma	Adjust the Khutma system settings.	/khutma
/language	Change the language of the bot.	/language <العربية|English|French>
/prayer	Adjust the settings of the Prayer Reminder.	/prayer
/reset	Reset the chat(text channel) of Azkar, Khutma, and Prayer Systems.	/reset
/recovery	Activate the recovery system in case the bot is restarted	/recovery

Developers

• @Arth(4i8)
• @albatranomar

License

Apache License 2.0

Contributing

Contributions are always welcome!
See contributing.md for ways to get started.
Please adhere to this project's code of conduct.