Skip to content

Scratchify is a lightweight and customizable scratch card SDK built using Jetpack Compose Multiplatform. It enables you to create interactive scratch surfaces where users can scratch off an overlay to reveal hidden content underneath. Ideal for rewards, discounts, surprise reveals, and gamification elements in your app!

License

Notifications You must be signed in to change notification settings

gsrathoreniks/Scratchify

Repository files navigation

Scratchify - A Compose Multiplatform Scratch Card SDK

Scratchify Github: Open Issues Scratchify Github Followers Twitter Follow GitHub License Scratchify


🚀 Introduction

Scratchify is a lightweight and customizable scratch card SDK built using Jetpack Compose Multiplatform. It enables you to create interactive scratch surfaces where users can scratch off an overlay to reveal hidden content underneath. Ideal for rewards, discounts, surprise reveals, and gamification elements in your app!

Perfect for:
Reward reveals
Discount coupons
Surprise elements
Gamification features


✨ Features

✔️ Multiplatform support (Android & iOS)
✔️ Two-layer scratch surface (Overlay & Revealed Content)
✔️ Customizable brush size
✔️ Auto-reveal after X% scratched
✔️ Instant reveal & reset options
✔️ Scratch event callbacks (onScratchStarted, onScratchProgress, onScratchCompleted)


📦 Implementation

1️⃣ Add Dependency

Since Scratchify is a Compose Multiplatform (CMP) library, you should add it to your commonMain source set to use it across both iOS and Android.

Add the dependency in your shared module's build.gradle.kts:

Maven Central

dependencies {
    implementation("io.github.gsrathoreniks:scratchify:<latest_version>")
}

🤝 Contributing

We welcome contributions from the community! 🚀

🛠 Submitting Issues & Feature Requests

We appreciate your help in improving Scratchify! 🎉


📜 License

This project is licensed under the MIT License.

📄 Read the full license: MIT License

About

Scratchify is a lightweight and customizable scratch card SDK built using Jetpack Compose Multiplatform. It enables you to create interactive scratch surfaces where users can scratch off an overlay to reveal hidden content underneath. Ideal for rewards, discounts, surprise reveals, and gamification elements in your app!

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages