MMM-RandomQuranAyah

This an extension for the MagicMirror. It will display Quran's ayah (verse) randomly from http://api.alquran.cloud. You can display whether arabic, translation, or both. All translation options can be found at http://api.alquran.cloud/edition.

Version

1.1

get and display current displayed Qur'an ayah/verse in telegram (requires MMM-TelegramBot) by typing command /quranverse

1.0

initial release

Screenshot

Installation

Navigate into your MagicMirror's modules folder
execute git clone https://github.com/slametps/MMM-RandomQuranAyah.git
if this module does not run correctlt, try npm install async

Using the module

To use this module, add it to the modules array in the config/config.js file:

modules: [
	{
		module: 'MMM-RandomQuranAyah',
		position: 'top_bar',	// This can be any of the regions. Best result is in the top_bar/bottom_bar as ayah (verse) can take multiple lines.
		config: {
			apiVersion: '1.0', // please, leave unchanged. reserved for future use.
			showArabic: true,
			showTranslation: true,
			surahArabicName:false,
			translationLang:'id.indonesian',
			updateInterval: 3600 * 1000, // milliseconds
		}
	}
]

Configuration options

The following properties can be configured:

Option	Description
`apiVersion`	1.0 (reserved for future use)
`showArabic`	display arabic? Possible values:`true`/`false` Default value: `true`
`showTranslation`	display translation? Possible values:`true`/`false` Default value: `true`
`surahArabicName`	display Surah name in Arabic? Possible values:`true`/`false` Default value: `false`
`translationLang`	List of the supported translation: http://api.alquran.cloud/edition Default value: `en.yusufali`
`updateInterval`	How ofter to get new ayah/verse? (milliseconds) Default value: `600000` (10 minutes)
`animationSpeed`	Speed of the update animation. (Milliseconds) Possible values:`0` - `5000` Default value: `2500` (2.5 seconds)

Dependencies

Access to the internet to download ayah (verse) from http://api.alquran.cloud

The MIT License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

The software is provided “as is”, without warranty of any kind, express or implied, including but not limited to the warranties of merchantability, fitness for a particular purpose and noninfringement. In no event shall the authors or copyright holders be liable for any claim, damages or other liability, whether in an action of contract, tort or otherwise, arising from, out of or in connection with the software or the use or other dealings in the software.

saiedmethal/MMM-RandomQuranAyah