Complete Quran toolkit: bundled Arabic DB with page map, transliteration and translation managers, search, audio URL resolution, tajweed span detection, and prayer-time calculation engine.
Multiplatform Quran stack built from the legacy QamarOld assets. Modules:
quran-core: SQLDelight schema + bundled Arabic text/page map (quran.db, arabic.json, quran_paged.json) and platform drivers.quran-transliteration: Loads transliteration JSON (KK/EN/RU) with JsonTransliterationProvider.quran-translations: Translation metadata + manager contracts (downloads TBD).quran-api: Public QuranApi facade on top of the core DB, transliteration, and translations.quran-search: Thin search helper delegating to QuranApi.quran-audio: Reciters list, audio URL resolution (config/templates), and Quran-Audio Project pure helpers for apps that store reciter by name/address (see below).quran-tajweed: Tajweed (recitation rules) detection: input Arabic verse text, output List<TajweedSpan> (start, end, rule). Platform-agnostic; use with verse text from QuranApi or any source. Rules: MAD, GHUNNA, QALQALA, IQLAB, IDGHAM, IKHFA, HAMZAT_WASL, MAD_HEY, ONE_MAD, MADDAH.prayer-core: Multiplatform prayer time calculation engine (ported from QamarOld). Works on Android, iOS, JS, Desktop. Supports multiple calculation methods (MWL, ISNA, Egypt, Makkah, etc.), Asr (Shafii/Hanafi), high-latitude adjustments, and timezone resolution (device default or Android CSV-based).For full Maven integration details and method-by-method API docs for every module, see:
docs/API_REFERENCE.mdAdd the dependencies to your build.gradle.kts:
dependencies {
// Core database and models
implementation("io.github.maqsats:quran-core:1.0.0")
// Public API
implementation("io.github.maqsats:quran-api:1.0.0")
// Translations
implementation("io.github.maqsats:quran-translations:1.0.0")
implementation()
implementation()
implementation()
implementation()
implementation()
}
For Kotlin Multiplatform projects, add the appropriate platform-specific dependencies as needed.
Source data comes from /Users/maqsat/StudioProjects/QamarOld/app/src/main:
res/values/arabic.xml, translit*.xmlassets/databases/qurankz.dbassets/translations.jsonRegenerate artifacts if the source changes:
cd /Users/maqsat/StudioProjects/qamar-kmp-libraries
python3 tools/generate_quran_db.py
# Copies are expected at:
# quran-core/src/commonMain/resources/{databases/quran.db,arabic.json,quran_paged.json}
# quran-transliteration/src/commonMain/resources/translit_{en,ru,kk}.json
# quran-translations/src/commonMain/resources/translations.json
// Platform-side: create driver (Android requires Context)
val driver = DatabaseFactory(context).createDriver()
val db = QuranDatabase(driver)
val api = DefaultQuranApi(
database = db,
translationManager = null, // wire in later
transliterationProvider = JsonTransliterationProvider(context)
)
val verse1 = api.getVerse(1, 1)
val page1 = api.getPage()
search = api.searchArabic()
verse1?.let { v -> TajweedApi.getTajweedSpans(v.arabicText) }
platformContextPass the same platformContext to all resource/database-backed components:
DatabaseFactory(platformContext)JsonTransliterationProvider(platformContext)TranslationMetadataSource(platformContext)Recommended shared initializer:
suspend fun createQuranApi(platformContext: Any?): QuranApi {
val driver = DatabaseFactory(platformContext).createDriver()
val db = QuranDatabase(driver)
val transliteration = JsonTransliterationProvider(platformContext)
return DefaultQuranApi(
database = db,
translationManager = null,
transliterationProvider = transliteration
)
}
Usage per target:
// Android
val api = createQuranApi(context.applicationContext)
// iOS / Desktop / JS
val api = createQuranApi(null)
Input: Arabic verse string (e.g. from QuranApi.getVerse(1, 1)?.arabicText). Output: List<TajweedSpan>(start, end, rule). Apply your own colors/spans per TajweedRule on Android (ForegroundColorSpan), Compose (SpanStyle), or iOS (NSAttributedString).
val verse = api.getVerse(1, 1)?.arabicText ?: ""
val spans = TajweedApi.getTajweedSpans(verse)
spans.forEach { (start, end, rule) -> /* apply color for rule */ }
Use a platform-specific TimeZoneProvider (all use the device's default time zone):
// Android / iOS / JS / Desktop: device timezone
val tzProvider = DefaultTimeZoneProvider() // or AndroidTimeZoneProvider() / IosTimeZoneProvider() / JsTimeZoneProvider() / JvmTimeZoneProvider()
val api = PrayerTimeApi(timeZoneProvider = tzProvider)
api.withCalculator { calculationMethod = CalculationMethod.MWL; timeFormat = TimeFormat.TIME_24 }
val date = DateComponents(, , )
times = api.getPrayerTimes(date, latitude = , longitude = -)
monthTimes = api.getPrayerTimesForMonth(, , , -)
On Android/iOS/JS/Desktop, use DateComponents(year, month, day) (1-based month). On JVM/Android you can use calendar.toDateComponents() from the platform extension.
arabic.json, quran_paged.json, and transliteration JSON.| Target | What to pass | Notes |
|---|
| Android | context.applicationContext | Required. DatabaseFactory throws if value is not an Android Context. |
| iOS | null | Current implementation reads from NSBundle.mainBundle; platformContext is not used. |
| Desktop (JVM) | null | Current implementation loads bundled resources via classpath; platformContext is not used. |
| JS (Browser/Node) | null | Current implementation does not use platformContext. |
Surfaced from shared tags and platforms — no rankings paid for.