├── .gitignore ├── LICENSE ├── README.md ├── build.gradle.kts ├── gradle.properties ├── gradle ├── libs.versions.toml └── wrapper │ ├── gradle-wrapper.jar │ └── gradle-wrapper.properties ├── gradlew ├── gradlew.bat ├── image └── Scratchify.jpg ├── sample ├── .gitignore ├── build.gradle.kts ├── proguard-rules.pro └── src │ ├── androidTest │ └── java │ │ └── com │ │ └── gsrathoreniks │ │ └── sample │ │ └── ExampleInstrumentedTest.kt │ ├── main │ ├── AndroidManifest.xml │ ├── java │ │ └── com │ │ │ └── gsrathoreniks │ │ │ └── sample │ │ │ ├── MainActivity.kt │ │ │ └── ui │ │ │ └── theme │ │ │ ├── Color.kt │ │ │ ├── Theme.kt │ │ │ └── Type.kt │ └── res │ │ ├── drawable │ │ ├── ic_launcher_background.xml │ │ └── ic_launcher_foreground.xml │ │ ├── mipmap-anydpi-v26 │ │ ├── ic_launcher.xml │ │ └── ic_launcher_round.xml │ │ ├── mipmap-hdpi │ │ ├── ic_launcher.webp │ │ └── ic_launcher_round.webp │ │ ├── mipmap-mdpi │ │ ├── ic_launcher.webp │ │ └── ic_launcher_round.webp │ │ ├── mipmap-xhdpi │ │ ├── ic_launcher.webp │ │ └── ic_launcher_round.webp │ │ ├── mipmap-xxhdpi │ │ ├── ic_launcher.webp │ │ └── ic_launcher_round.webp │ │ ├── mipmap-xxxhdpi │ │ ├── ic_launcher.webp │ │ └── ic_launcher_round.webp │ │ └── values │ │ ├── colors.xml │ │ ├── strings.xml │ │ └── themes.xml │ └── test │ └── java │ └── com │ └── gsrathoreniks │ └── sample │ └── ExampleUnitTest.kt ├── scratchify ├── build.gradle.kts └── src │ └── commonMain │ └── kotlin │ └── com │ └── gsrathoreniks │ └── scratchify │ ├── api │ ├── ScratchGridTracker.kt │ ├── Scratchify.kt │ ├── ScratchifyController.kt │ └── config │ │ ├── ScratchifyBrushConfig.kt │ │ └── ScratchifyConfig.kt │ └── internal │ └── extension │ ├── ModifierExt.kt │ └── OffsetExt.kt └── settings.gradle.kts /.gitignore: -------------------------------------------------------------------------------- 1 | *.iml 2 | .gradle 3 | .idea 4 | .kotlin 5 | .DS_Store 6 | build 7 | captures 8 | .externalNativeBuild 9 | .cxx 10 | local.properties 11 | xcuserdata -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2025 Gajendra Singh Rathore 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Scratchify - A Compose Multiplatform Scratch Card SDK 2 | 3 | ![Scratchify](image/Scratchify.jpg) 4 | ![Github: Open Issues](https://img.shields.io/github/issues-raw/gsrathoreniks/scratchify?color=7E8EFB&label=Scratchify%3A%20Open%20Issues) 5 | ![Scratchify](https://img.shields.io/maven-central/v/io.github.gsrathoreniks/scratchify?style=flat&label=Scratchify) 6 | [![Github Followers](https://img.shields.io/github/followers/gsrathoreniks?label=Follow&style=social)](https://github.com/gsrathoreniks) 7 | [![Twitter Follow](https://img.shields.io/twitter/follow/gsrathoreniks?label=Follow&style=social)](https://twitter.com/gsrathoreniks) 8 | ![GitHub License](https://img.shields.io/github/license/gsrathoreniks/scratchify?link=https%3A%2F%2Fgithub.com%2Fgsrathoreniks%2FScratchify%3Ftab%3DMIT-1-ov-file%23MIT-1-ov-file) 9 | [![Scratchify](https://img.shields.io/badge/Android%20Weekly-%23667-Pink)](https://androidweekly.net/issues/issue-667) 10 | 11 | --- 12 | 13 | ## 🚀 Introduction 14 | 15 | 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! 16 | 17 | Perfect for: 18 | ✅ **Reward reveals** 19 | ✅ **Discount coupons** 20 | ✅ **Surprise elements** 21 | ✅ **Gamification features** 22 | 23 | --- 24 | 25 | ## ✨ Features 26 | 27 | ✔️ **Multiplatform support** (Android & iOS) 28 | ✔️ **Two-layer scratch surface** (Overlay & Revealed Content) 29 | ✔️ **Customizable brush size** 30 | ✔️ **Auto-reveal after X% scratched** 31 | ✔️ **Instant reveal & reset options** 32 | ✔️ **Scratch event callbacks** (`onScratchStarted`, `onScratchProgress`, `onScratchCompleted`) 33 | 34 | 35 | --- 36 | 37 | ## 📦 Implementation 38 | 39 | ### 1️⃣ Add Dependency 40 | 41 | 42 | 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. 43 | 44 | Add the dependency in your `shared` module's `build.gradle.kts`: 45 | 46 | 47 | [![Maven Central](https://img.shields.io/maven-central/v/io.github.gsrathoreniks/scratchify?style=flat)](https://central.sonatype.com/search?q=io.github.gsrathoreniks.scratchify) 48 | ```kotlin 49 | dependencies { 50 | implementation("io.github.gsrathoreniks:scratchify:") 51 | } 52 | ``` 53 | 54 | --- 55 | 56 | 57 | ## 🤝 Contributing 58 | 59 | We welcome contributions from the community! 🚀 60 | 61 | ### 🛠 Submitting Issues & Feature Requests 62 | - Found a **bug**? **[Open an Issue](https://github.com/gsrathoreniks/scratchify/issues/new?labels=bug&template=bug_report.md)** 63 | - Have a **feature request**? **[Suggest a Feature](https://github.com/gsrathoreniks/scratchify/issues/new?labels=enhancement&template=feature_request.md)** 64 | 65 | We appreciate your help in improving **Scratchify**! 🎉 66 | 67 | --- 68 | 69 | ## 📜 License 70 | 71 | This project is licensed under the **MIT License**. 72 | 73 | 📄 **Read the full license**: [MIT License](https%3A%2F%2Fgithub.com%2Fgsrathoreniks%2FScratchify%3Ftab%3DMIT-1-ov-file%23MIT-1-ov-file) 74 | 75 | 76 | 77 | 78 | -------------------------------------------------------------------------------- /build.gradle.kts: -------------------------------------------------------------------------------- 1 | plugins { 2 | //trick: for the same plugin versions in all sub-modules 3 | alias(libs.plugins.androidLibrary).apply(false) 4 | alias(libs.plugins.kotlinMultiplatform).apply(false) 5 | alias(libs.plugins.androidApplication) apply false 6 | alias(libs.plugins.kotlinAndroid) apply false 7 | alias(libs.plugins.compose.compiler) apply false 8 | alias(libs.plugins.composeMultiplatform) apply false 9 | } 10 | -------------------------------------------------------------------------------- /gradle.properties: -------------------------------------------------------------------------------- 1 | #Gradle 2 | org.gradle.jvmargs=-Xmx2048M -Dfile.encoding=UTF-8 -Dkotlin.daemon.jvm.options\="-Xmx2048M" 3 | org.gradle.caching=true 4 | org.gradle.configuration-cache=true 5 | 6 | #Kotlin 7 | kotlin.code.style=official 8 | 9 | #Android 10 | android.useAndroidX=true 11 | android.nonTransitiveRClass=true -------------------------------------------------------------------------------- /gradle/libs.versions.toml: -------------------------------------------------------------------------------- 1 | [versions] 2 | agp = "8.9.0-beta01" 3 | kotlin = "2.0.0" 4 | compose = "1.5.4" 5 | compose-material3 = "1.1.2" 6 | androidx-activityCompose = "1.8.0" 7 | coreKtx = "1.15.0" 8 | junit = "4.13.2" 9 | junitVersion = "1.2.1" 10 | espressoCore = "3.6.1" 11 | lifecycleRuntimeKtx = "2.8.7" 12 | composeBom = "2024.09.00" 13 | runtimeAndroid = "1.7.8" 14 | jetbrain-compose = "1.7.3" 15 | publish = "0.30.0" 16 | 17 | [libraries] 18 | kotlin-test = { module = "org.jetbrains.kotlin:kotlin-test", version.ref = "kotlin" } 19 | androidx-activity-compose = { module = "androidx.activity:activity-compose", version.ref = "androidx-activityCompose" } 20 | compose-ui = { module = "androidx.compose.ui:ui", version.ref = "compose" } 21 | compose-ui-tooling = { module = "androidx.compose.ui:ui-tooling", version.ref = "compose" } 22 | compose-ui-tooling-preview = { module = "androidx.compose.ui:ui-tooling-preview", version.ref = "compose" } 23 | compose-foundation = { module = "androidx.compose.foundation:foundation", version.ref = "compose" } 24 | compose-material3 = { module = "androidx.compose.material3:material3", version.ref = "compose-material3" } 25 | androidx-core-ktx = { group = "androidx.core", name = "core-ktx", version.ref = "coreKtx" } 26 | junit = { group = "junit", name = "junit", version.ref = "junit" } 27 | androidx-junit = { group = "androidx.test.ext", name = "junit", version.ref = "junitVersion" } 28 | androidx-espresso-core = { group = "androidx.test.espresso", name = "espresso-core", version.ref = "espressoCore" } 29 | androidx-lifecycle-runtime-ktx = { group = "androidx.lifecycle", name = "lifecycle-runtime-ktx", version.ref = "lifecycleRuntimeKtx" } 30 | androidx-compose-bom = { group = "androidx.compose", name = "compose-bom", version.ref = "composeBom" } 31 | androidx-ui-graphics = { group = "androidx.compose.ui", name = "ui-graphics" } 32 | androidx-ui-test-manifest = { group = "androidx.compose.ui", name = "ui-test-manifest" } 33 | androidx-ui-test-junit4 = { group = "androidx.compose.ui", name = "ui-test-junit4" } 34 | androidx-runtime-android = { group = "androidx.compose.runtime", name = "runtime-android", version.ref = "runtimeAndroid" } 35 | 36 | [plugins] 37 | publish = { id = "com.vanniktech.maven.publish", version.ref = "publish" } 38 | androidApplication = { id = "com.android.application", version.ref = "agp" } 39 | androidLibrary = { id = "com.android.library", version.ref = "agp" } 40 | kotlinAndroid = { id = "org.jetbrains.kotlin.android", version.ref = "kotlin" } 41 | composeMultiplatform = { id = "org.jetbrains.compose", version.ref = "jetbrain-compose" } 42 | kotlinMultiplatform = { id = "org.jetbrains.kotlin.multiplatform", version.ref = "kotlin" } 43 | kotlinCocoapods = { id = "org.jetbrains.kotlin.native.cocoapods", version.ref = "kotlin" } 44 | compose-compiler = { id = "org.jetbrains.kotlin.plugin.compose", version.ref = "kotlin" } 45 | -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.jar: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/gsrathoreniks/Scratchify/214e95366ddd711c47db7be58be8e16f5feddefa/gradle/wrapper/gradle-wrapper.jar -------------------------------------------------------------------------------- /gradle/wrapper/gradle-wrapper.properties: -------------------------------------------------------------------------------- 1 | #Sun Mar 16 14:40:49 IST 2025 2 | distributionBase=GRADLE_USER_HOME 3 | distributionPath=wrapper/dists 4 | distributionUrl=https\://services.gradle.org/distributions/gradle-8.11.1-bin.zip 5 | zipStoreBase=GRADLE_USER_HOME 6 | zipStorePath=wrapper/dists 7 | -------------------------------------------------------------------------------- /gradlew: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env sh 2 | 3 | # 4 | # Copyright 2015 the original author or authors. 5 | # 6 | # Licensed under the Apache License, Version 2.0 (the "License"); 7 | # you may not use this file except in compliance with the License. 8 | # You may obtain a copy of the License at 9 | # 10 | # https://www.apache.org/licenses/LICENSE-2.0 11 | # 12 | # Unless required by applicable law or agreed to in writing, software 13 | # distributed under the License is distributed on an "AS IS" BASIS, 14 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 | # See the License for the specific language governing permissions and 16 | # limitations under the License. 17 | # 18 | 19 | ############################################################################## 20 | ## 21 | ## Gradle start up script for UN*X 22 | ## 23 | ############################################################################## 24 | 25 | # Attempt to set APP_HOME 26 | # Resolve links: $0 may be a link 27 | PRG="$0" 28 | # Need this for relative symlinks. 29 | while [ -h "$PRG" ] ; do 30 | ls=`ls -ld "$PRG"` 31 | link=`expr "$ls" : '.*-> \(.*\)$'` 32 | if expr "$link" : '/.*' > /dev/null; then 33 | PRG="$link" 34 | else 35 | PRG=`dirname "$PRG"`"/$link" 36 | fi 37 | done 38 | SAVED="`pwd`" 39 | cd "`dirname \"$PRG\"`/" >/dev/null 40 | APP_HOME="`pwd -P`" 41 | cd "$SAVED" >/dev/null 42 | 43 | APP_NAME="Gradle" 44 | APP_BASE_NAME=`basename "$0"` 45 | 46 | # Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 47 | DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"' 48 | 49 | # Use the maximum available, or set MAX_FD != -1 to use that value. 50 | MAX_FD="maximum" 51 | 52 | warn () { 53 | echo "$*" 54 | } 55 | 56 | die () { 57 | echo 58 | echo "$*" 59 | echo 60 | exit 1 61 | } 62 | 63 | # OS specific support (must be 'true' or 'false'). 64 | cygwin=false 65 | msys=false 66 | darwin=false 67 | nonstop=false 68 | case "`uname`" in 69 | CYGWIN* ) 70 | cygwin=true 71 | ;; 72 | Darwin* ) 73 | darwin=true 74 | ;; 75 | MINGW* ) 76 | msys=true 77 | ;; 78 | NONSTOP* ) 79 | nonstop=true 80 | ;; 81 | esac 82 | 83 | CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar 84 | 85 | 86 | # Determine the Java command to use to start the JVM. 87 | if [ -n "$JAVA_HOME" ] ; then 88 | if [ -x "$JAVA_HOME/jre/sh/java" ] ; then 89 | # IBM's JDK on AIX uses strange locations for the executables 90 | JAVACMD="$JAVA_HOME/jre/sh/java" 91 | else 92 | JAVACMD="$JAVA_HOME/bin/java" 93 | fi 94 | if [ ! -x "$JAVACMD" ] ; then 95 | die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME 96 | 97 | Please set the JAVA_HOME variable in your environment to match the 98 | location of your Java installation." 99 | fi 100 | else 101 | JAVACMD="java" 102 | which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 103 | 104 | Please set the JAVA_HOME variable in your environment to match the 105 | location of your Java installation." 106 | fi 107 | 108 | # Increase the maximum file descriptors if we can. 109 | if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then 110 | MAX_FD_LIMIT=`ulimit -H -n` 111 | if [ $? -eq 0 ] ; then 112 | if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then 113 | MAX_FD="$MAX_FD_LIMIT" 114 | fi 115 | ulimit -n $MAX_FD 116 | if [ $? -ne 0 ] ; then 117 | warn "Could not set maximum file descriptor limit: $MAX_FD" 118 | fi 119 | else 120 | warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT" 121 | fi 122 | fi 123 | 124 | # For Darwin, add options to specify how the application appears in the dock 125 | if $darwin; then 126 | GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\"" 127 | fi 128 | 129 | # For Cygwin or MSYS, switch paths to Windows format before running java 130 | if [ "$cygwin" = "true" -o "$msys" = "true" ] ; then 131 | APP_HOME=`cygpath --path --mixed "$APP_HOME"` 132 | CLASSPATH=`cygpath --path --mixed "$CLASSPATH"` 133 | 134 | JAVACMD=`cygpath --unix "$JAVACMD"` 135 | 136 | # We build the pattern for arguments to be converted via cygpath 137 | ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null` 138 | SEP="" 139 | for dir in $ROOTDIRSRAW ; do 140 | ROOTDIRS="$ROOTDIRS$SEP$dir" 141 | SEP="|" 142 | done 143 | OURCYGPATTERN="(^($ROOTDIRS))" 144 | # Add a user-defined pattern to the cygpath arguments 145 | if [ "$GRADLE_CYGPATTERN" != "" ] ; then 146 | OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)" 147 | fi 148 | # Now convert the arguments - kludge to limit ourselves to /bin/sh 149 | i=0 150 | for arg in "$@" ; do 151 | CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -` 152 | CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option 153 | 154 | if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition 155 | eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"` 156 | else 157 | eval `echo args$i`="\"$arg\"" 158 | fi 159 | i=`expr $i + 1` 160 | done 161 | case $i in 162 | 0) set -- ;; 163 | 1) set -- "$args0" ;; 164 | 2) set -- "$args0" "$args1" ;; 165 | 3) set -- "$args0" "$args1" "$args2" ;; 166 | 4) set -- "$args0" "$args1" "$args2" "$args3" ;; 167 | 5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;; 168 | 6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;; 169 | 7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;; 170 | 8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;; 171 | 9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;; 172 | esac 173 | fi 174 | 175 | # Escape application args 176 | save () { 177 | for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done 178 | echo " " 179 | } 180 | APP_ARGS=`save "$@"` 181 | 182 | # Collect all arguments for the java command, following the shell quoting and substitution rules 183 | eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS" 184 | 185 | exec "$JAVACMD" "$@" 186 | -------------------------------------------------------------------------------- /gradlew.bat: -------------------------------------------------------------------------------- 1 | @rem 2 | @rem Copyright 2015 the original author or authors. 3 | @rem 4 | @rem Licensed under the Apache License, Version 2.0 (the "License"); 5 | @rem you may not use this file except in compliance with the License. 6 | @rem You may obtain a copy of the License at 7 | @rem 8 | @rem https://www.apache.org/licenses/LICENSE-2.0 9 | @rem 10 | @rem Unless required by applicable law or agreed to in writing, software 11 | @rem distributed under the License is distributed on an "AS IS" BASIS, 12 | @rem WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | @rem See the License for the specific language governing permissions and 14 | @rem limitations under the License. 15 | @rem 16 | 17 | @if "%DEBUG%" == "" @echo off 18 | @rem ########################################################################## 19 | @rem 20 | @rem Gradle startup script for Windows 21 | @rem 22 | @rem ########################################################################## 23 | 24 | @rem Set local scope for the variables with windows NT shell 25 | if "%OS%"=="Windows_NT" setlocal 26 | 27 | set DIRNAME=%~dp0 28 | if "%DIRNAME%" == "" set DIRNAME=. 29 | set APP_BASE_NAME=%~n0 30 | set APP_HOME=%DIRNAME% 31 | 32 | @rem Resolve any "." and ".." in APP_HOME to make it shorter. 33 | for %%i in ("%APP_HOME%") do set APP_HOME=%%~fi 34 | 35 | @rem Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script. 36 | set DEFAULT_JVM_OPTS="-Xmx64m" "-Xms64m" 37 | 38 | @rem Find java.exe 39 | if defined JAVA_HOME goto findJavaFromJavaHome 40 | 41 | set JAVA_EXE=java.exe 42 | %JAVA_EXE% -version >NUL 2>&1 43 | if "%ERRORLEVEL%" == "0" goto execute 44 | 45 | echo. 46 | echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH. 47 | echo. 48 | echo Please set the JAVA_HOME variable in your environment to match the 49 | echo location of your Java installation. 50 | 51 | goto fail 52 | 53 | :findJavaFromJavaHome 54 | set JAVA_HOME=%JAVA_HOME:"=% 55 | set JAVA_EXE=%JAVA_HOME%/bin/java.exe 56 | 57 | if exist "%JAVA_EXE%" goto execute 58 | 59 | echo. 60 | echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME% 61 | echo. 62 | echo Please set the JAVA_HOME variable in your environment to match the 63 | echo location of your Java installation. 64 | 65 | goto fail 66 | 67 | :execute 68 | @rem Setup the command line 69 | 70 | set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar 71 | 72 | 73 | @rem Execute Gradle 74 | "%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %* 75 | 76 | :end 77 | @rem End local scope for the variables with windows NT shell 78 | if "%ERRORLEVEL%"=="0" goto mainEnd 79 | 80 | :fail 81 | rem Set variable GRADLE_EXIT_CONSOLE if you need the _script_ return code instead of 82 | rem the _cmd.exe /c_ return code! 83 | if not "" == "%GRADLE_EXIT_CONSOLE%" exit 1 84 | exit /b 1 85 | 86 | :mainEnd 87 | if "%OS%"=="Windows_NT" endlocal 88 | 89 | :omega 90 | -------------------------------------------------------------------------------- /image/Scratchify.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/gsrathoreniks/Scratchify/214e95366ddd711c47db7be58be8e16f5feddefa/image/Scratchify.jpg -------------------------------------------------------------------------------- /sample/.gitignore: -------------------------------------------------------------------------------- 1 | /build -------------------------------------------------------------------------------- /sample/build.gradle.kts: -------------------------------------------------------------------------------- 1 | plugins { 2 | alias(libs.plugins.androidApplication) 3 | alias(libs.plugins.kotlinAndroid) 4 | alias(libs.plugins.compose.compiler) 5 | } 6 | 7 | android { 8 | namespace = "com.gsrathoreniks.sample" 9 | compileSdk = 35 10 | 11 | defaultConfig { 12 | applicationId = "com.gsrathoreniks.sample" 13 | minSdk = 24 14 | targetSdk = 35 15 | versionCode = 1 16 | versionName = "1.0" 17 | 18 | testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner" 19 | } 20 | 21 | buildTypes { 22 | release { 23 | isMinifyEnabled = false 24 | proguardFiles( 25 | getDefaultProguardFile("proguard-android-optimize.txt"), 26 | "proguard-rules.pro" 27 | ) 28 | } 29 | } 30 | compileOptions { 31 | sourceCompatibility = JavaVersion.VERSION_11 32 | targetCompatibility = JavaVersion.VERSION_11 33 | } 34 | kotlinOptions { 35 | jvmTarget = "11" 36 | } 37 | buildFeatures { 38 | compose = true 39 | } 40 | } 41 | 42 | dependencies { 43 | implementation(project(":scratchify")) 44 | implementation(libs.androidx.core.ktx) 45 | implementation(libs.androidx.lifecycle.runtime.ktx) 46 | implementation(libs.androidx.activity.compose) 47 | implementation(platform(libs.androidx.compose.bom)) 48 | implementation(libs.compose.ui) 49 | implementation(libs.androidx.ui.graphics) 50 | implementation(libs.compose.ui.tooling.preview) 51 | implementation(libs.compose.material3) 52 | testImplementation(libs.junit) 53 | androidTestImplementation(libs.androidx.junit) 54 | androidTestImplementation(libs.androidx.espresso.core) 55 | androidTestImplementation(platform(libs.androidx.compose.bom)) 56 | androidTestImplementation(libs.androidx.ui.test.junit4) 57 | debugImplementation(libs.compose.ui.tooling) 58 | debugImplementation(libs.androidx.ui.test.manifest) 59 | } -------------------------------------------------------------------------------- /sample/proguard-rules.pro: -------------------------------------------------------------------------------- 1 | # Add project specific ProGuard rules here. 2 | # You can control the set of applied configuration files using the 3 | # proguardFiles setting in build.gradle. 4 | # 5 | # For more details, see 6 | # http://developer.android.com/guide/developing/tools/proguard.html 7 | 8 | # If your project uses WebView with JS, uncomment the following 9 | # and specify the fully qualified class name to the JavaScript interface 10 | # class: 11 | #-keepclassmembers class fqcn.of.javascript.interface.for.webview { 12 | # public *; 13 | #} 14 | 15 | # Uncomment this to preserve the line number information for 16 | # debugging stack traces. 17 | #-keepattributes SourceFile,LineNumberTable 18 | 19 | # If you keep the line number information, uncomment this to 20 | # hide the original source file name. 21 | #-renamesourcefileattribute SourceFile -------------------------------------------------------------------------------- /sample/src/androidTest/java/com/gsrathoreniks/sample/ExampleInstrumentedTest.kt: -------------------------------------------------------------------------------- 1 | package com.gsrathoreniks.sample 2 | 3 | import androidx.test.ext.junit.runners.AndroidJUnit4 4 | import androidx.test.platform.app.InstrumentationRegistry 5 | import org.junit.Assert.assertEquals 6 | import org.junit.Test 7 | import org.junit.runner.RunWith 8 | 9 | /** 10 | * Instrumented test, which will execute on an Android device. 11 | * 12 | * See [testing documentation](http://d.android.com/tools/testing). 13 | */ 14 | @RunWith(AndroidJUnit4::class) 15 | class ExampleInstrumentedTest { 16 | @Test 17 | fun useAppContext() { 18 | // Context of the app under test. 19 | val appContext = InstrumentationRegistry.getInstrumentation().targetContext 20 | assertEquals("com.gsrathoreniks.sample", appContext.packageName) 21 | } 22 | } -------------------------------------------------------------------------------- /sample/src/main/AndroidManifest.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 11 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | -------------------------------------------------------------------------------- /sample/src/main/java/com/gsrathoreniks/sample/MainActivity.kt: -------------------------------------------------------------------------------- 1 | package com.gsrathoreniks.sample 2 | 3 | import android.os.Bundle 4 | import androidx.activity.ComponentActivity 5 | import androidx.activity.compose.setContent 6 | import androidx.activity.enableEdgeToEdge 7 | import androidx.compose.foundation.background 8 | import androidx.compose.foundation.layout.Box 9 | import androidx.compose.foundation.layout.Column 10 | import androidx.compose.foundation.layout.fillMaxSize 11 | import androidx.compose.foundation.layout.fillMaxWidth 12 | import androidx.compose.foundation.layout.height 13 | import androidx.compose.foundation.layout.padding 14 | import androidx.compose.material3.Scaffold 15 | import androidx.compose.material3.Text 16 | import androidx.compose.runtime.Composable 17 | import androidx.compose.runtime.remember 18 | import androidx.compose.ui.Alignment 19 | import androidx.compose.ui.Modifier 20 | import androidx.compose.ui.graphics.Color 21 | import androidx.compose.ui.tooling.preview.Preview 22 | import androidx.compose.ui.unit.dp 23 | import androidx.compose.ui.unit.sp 24 | import com.gsrathoreniks.sample.ui.theme.ScratchifyTheme 25 | import com.gsrathoreniks.scratchify.api.Scratchify 26 | import com.gsrathoreniks.scratchify.api.ScratchifyController 27 | import com.gsrathoreniks.scratchify.api.config.ScratchifyBrushConfig 28 | import com.gsrathoreniks.scratchify.api.config.ScratchifyConfig 29 | 30 | class MainActivity : ComponentActivity() { 31 | override fun onCreate(savedInstanceState: Bundle?) { 32 | super.onCreate(savedInstanceState) 33 | enableEdgeToEdge() 34 | setContent { 35 | ScratchifyTheme { 36 | Scaffold(modifier = Modifier.fillMaxSize().background(Color.Blue)) { innerPadding -> 37 | Content(modifier = Modifier.padding(innerPadding)) 38 | } 39 | } 40 | } 41 | } 42 | } 43 | 44 | @Composable 45 | fun Content(modifier: Modifier = Modifier) { 46 | val scratchController = remember { ScratchifyController() } 47 | Column(modifier = modifier.fillMaxSize()) { 48 | // 1. Default ScratchifyView Example 49 | Box( 50 | modifier = Modifier 51 | .fillMaxWidth() 52 | .height(200.dp) 53 | .padding(8.dp), 54 | contentAlignment = Alignment.Center 55 | ) { 56 | Scratchify( 57 | modifier = Modifier.fillMaxSize(), 58 | config = ScratchifyConfig(), 59 | controller = scratchController, 60 | contentToReveal = { ContentToReveal("Default Scratch Config") }, 61 | overlayContent = { OverlayContent("Scratch Me!") } 62 | ) 63 | } 64 | Text( 65 | text = "Scratch Progress: ${scratchController.scratchProgress}", 66 | color = Color.White, 67 | modifier = Modifier.padding(horizontal = 16.dp) 68 | ) 69 | 70 | // 2. Custom Brush Size Example 71 | val brushSizeConfig = ScratchifyConfig(brushConfig = ScratchifyBrushConfig(brushSize = 50.dp)) 72 | Box( 73 | modifier = Modifier 74 | .fillMaxWidth() 75 | .height(200.dp) 76 | .padding(8.dp), 77 | contentAlignment = Alignment.Center 78 | ) { 79 | Scratchify( 80 | modifier = Modifier.fillMaxSize(), 81 | config = brushSizeConfig, 82 | controller = remember { ScratchifyController() }, 83 | contentToReveal = { ContentToReveal("Large Brush Size!") }, 84 | overlayContent = { OverlayContent("Scratch to Reveal!") } 85 | ) 86 | } 87 | 88 | // 3. Custom Reveal Threshold Example 89 | val customThresholdController = remember { ScratchifyController() } 90 | val thresholdConfig = ScratchifyConfig(revealFullAtPercent = 0.5f) 91 | Box( 92 | modifier = Modifier 93 | .fillMaxWidth() 94 | .height(200.dp) 95 | .padding(8.dp), 96 | contentAlignment = Alignment.Center 97 | ) { 98 | Scratchify( 99 | modifier = Modifier.fillMaxSize(), 100 | config = thresholdConfig, 101 | controller = customThresholdController, 102 | contentToReveal = { ContentToReveal("50% Scratch to Reveal!") }, 103 | overlayContent = { OverlayContent("Keep Scratching!") } 104 | ) 105 | } 106 | Text( 107 | text = "Custom Threshold Progress: ${customThresholdController.scratchProgress}", 108 | color = Color.White, 109 | modifier = Modifier.padding(horizontal = 16.dp) 110 | ) 111 | 112 | // 4. Scratch Callbacks Example 113 | val callbackController = remember { ScratchifyController() } 114 | callbackController.onScratchStarted = { 115 | println("Scratch Started!") 116 | } 117 | callbackController.onScratchProgress = { progress -> 118 | println("Scratch Progress: $progress") 119 | } 120 | callbackController.onScratchCompleted = { 121 | println("Scratch Completed!") 122 | } 123 | Box( 124 | modifier = Modifier 125 | .fillMaxWidth() 126 | .height(200.dp) 127 | .padding(8.dp), 128 | contentAlignment = Alignment.Center 129 | ) { 130 | Scratchify( 131 | modifier = Modifier.fillMaxSize(), 132 | config = ScratchifyConfig(), 133 | controller = callbackController, 134 | contentToReveal = { ContentToReveal("Scratch Callbacks!") }, 135 | overlayContent = { OverlayContent("Callbacks in Action!") } 136 | ) 137 | } 138 | } 139 | } 140 | 141 | 142 | @Composable 143 | fun ContentToReveal(message: String) { 144 | Box( 145 | contentAlignment = Alignment.Center, 146 | modifier = Modifier 147 | .fillMaxWidth() 148 | .height(200.dp) 149 | .background(Color.Green) 150 | ) { 151 | Text( 152 | text = message, 153 | fontSize = 24.sp, 154 | color = Color.Black 155 | ) 156 | } 157 | } 158 | 159 | @Composable 160 | fun OverlayContent(message: String) { 161 | Box( 162 | contentAlignment = Alignment.Center, 163 | modifier = Modifier 164 | .fillMaxWidth() 165 | .height(200.dp) 166 | .background(Color.Red) 167 | ) { 168 | Text( 169 | text = message, 170 | fontSize = 24.sp, 171 | color = Color.White 172 | ) 173 | } 174 | } 175 | 176 | 177 | @Preview(showBackground = true, showSystemUi = true) 178 | @Composable 179 | fun GreetingPreview() { 180 | ScratchifyTheme { 181 | Content() 182 | } 183 | } -------------------------------------------------------------------------------- /sample/src/main/java/com/gsrathoreniks/sample/ui/theme/Color.kt: -------------------------------------------------------------------------------- 1 | package com.gsrathoreniks.sample.ui.theme 2 | 3 | import androidx.compose.ui.graphics.Color 4 | 5 | val Purple80 = Color(0xFFD0BCFF) 6 | val PurpleGrey80 = Color(0xFFCCC2DC) 7 | val Pink80 = Color(0xFFEFB8C8) 8 | 9 | val Purple40 = Color(0xFF6650a4) 10 | val PurpleGrey40 = Color(0xFF625b71) 11 | val Pink40 = Color(0xFF7D5260) -------------------------------------------------------------------------------- /sample/src/main/java/com/gsrathoreniks/sample/ui/theme/Theme.kt: -------------------------------------------------------------------------------- 1 | package com.gsrathoreniks.sample.ui.theme 2 | 3 | import android.os.Build 4 | import androidx.compose.foundation.isSystemInDarkTheme 5 | import androidx.compose.material3.MaterialTheme 6 | import androidx.compose.material3.darkColorScheme 7 | import androidx.compose.material3.dynamicDarkColorScheme 8 | import androidx.compose.material3.dynamicLightColorScheme 9 | import androidx.compose.material3.lightColorScheme 10 | import androidx.compose.runtime.Composable 11 | import androidx.compose.ui.platform.LocalContext 12 | 13 | private val DarkColorScheme = darkColorScheme( 14 | primary = Purple80, 15 | secondary = PurpleGrey80, 16 | tertiary = Pink80 17 | ) 18 | 19 | private val LightColorScheme = lightColorScheme( 20 | primary = Purple40, 21 | secondary = PurpleGrey40, 22 | tertiary = Pink40 23 | 24 | /* Other default colors to override 25 | background = Color(0xFFFFFBFE), 26 | surface = Color(0xFFFFFBFE), 27 | onPrimary = Color.White, 28 | onSecondary = Color.White, 29 | onTertiary = Color.White, 30 | onBackground = Color(0xFF1C1B1F), 31 | onSurface = Color(0xFF1C1B1F), 32 | */ 33 | ) 34 | 35 | @Composable 36 | fun ScratchifyTheme( 37 | darkTheme: Boolean = isSystemInDarkTheme(), 38 | // Dynamic color is available on Android 12+ 39 | dynamicColor: Boolean = true, 40 | content: @Composable () -> Unit, 41 | ) { 42 | val colorScheme = when { 43 | dynamicColor && Build.VERSION.SDK_INT >= Build.VERSION_CODES.S -> { 44 | val context = LocalContext.current 45 | if (darkTheme) dynamicDarkColorScheme(context) else dynamicLightColorScheme(context) 46 | } 47 | 48 | darkTheme -> DarkColorScheme 49 | else -> LightColorScheme 50 | } 51 | 52 | MaterialTheme( 53 | colorScheme = colorScheme, 54 | typography = Typography, 55 | content = content 56 | ) 57 | } -------------------------------------------------------------------------------- /sample/src/main/java/com/gsrathoreniks/sample/ui/theme/Type.kt: -------------------------------------------------------------------------------- 1 | package com.gsrathoreniks.sample.ui.theme 2 | 3 | import androidx.compose.material3.Typography 4 | import androidx.compose.ui.text.TextStyle 5 | import androidx.compose.ui.text.font.FontFamily 6 | import androidx.compose.ui.text.font.FontWeight 7 | import androidx.compose.ui.unit.sp 8 | 9 | // Set of Material typography styles to start with 10 | val Typography = Typography( 11 | bodyLarge = TextStyle( 12 | fontFamily = FontFamily.Default, 13 | fontWeight = FontWeight.Normal, 14 | fontSize = 16.sp, 15 | lineHeight = 24.sp, 16 | letterSpacing = 0.5.sp 17 | ) 18 | /* Other default text styles to override 19 | titleLarge = TextStyle( 20 | fontFamily = FontFamily.Default, 21 | fontWeight = FontWeight.Normal, 22 | fontSize = 22.sp, 23 | lineHeight = 28.sp, 24 | letterSpacing = 0.sp 25 | ), 26 | labelSmall = TextStyle( 27 | fontFamily = FontFamily.Default, 28 | fontWeight = FontWeight.Medium, 29 | fontSize = 11.sp, 30 | lineHeight = 16.sp, 31 | letterSpacing = 0.5.sp 32 | ) 33 | */ 34 | ) -------------------------------------------------------------------------------- /sample/src/main/res/drawable/ic_launcher_background.xml: -------------------------------------------------------------------------------- 1 | 2 | 7 | 10 | 15 | 20 | 25 | 30 | 35 | 40 | 45 | 50 | 55 | 60 | 65 | 70 | 75 | 80 | 85 | 90 | 95 | 100 | 105 | 110 | 115 | 120 | 125 | 130 | 135 | 140 | 145 | 150 | 155 | 160 | 165 | 170 | 171 | -------------------------------------------------------------------------------- /sample/src/main/res/drawable/ic_launcher_foreground.xml: -------------------------------------------------------------------------------- 1 | 7 | 8 | 9 | 15 | 18 | 21 | 22 | 23 | 24 | 30 | -------------------------------------------------------------------------------- /sample/src/main/res/mipmap-anydpi-v26/ic_launcher.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | -------------------------------------------------------------------------------- /sample/src/main/res/mipmap-anydpi-v26/ic_launcher_round.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | -------------------------------------------------------------------------------- /sample/src/main/res/mipmap-hdpi/ic_launcher.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/gsrathoreniks/Scratchify/214e95366ddd711c47db7be58be8e16f5feddefa/sample/src/main/res/mipmap-hdpi/ic_launcher.webp -------------------------------------------------------------------------------- /sample/src/main/res/mipmap-hdpi/ic_launcher_round.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/gsrathoreniks/Scratchify/214e95366ddd711c47db7be58be8e16f5feddefa/sample/src/main/res/mipmap-hdpi/ic_launcher_round.webp -------------------------------------------------------------------------------- /sample/src/main/res/mipmap-mdpi/ic_launcher.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/gsrathoreniks/Scratchify/214e95366ddd711c47db7be58be8e16f5feddefa/sample/src/main/res/mipmap-mdpi/ic_launcher.webp -------------------------------------------------------------------------------- /sample/src/main/res/mipmap-mdpi/ic_launcher_round.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/gsrathoreniks/Scratchify/214e95366ddd711c47db7be58be8e16f5feddefa/sample/src/main/res/mipmap-mdpi/ic_launcher_round.webp -------------------------------------------------------------------------------- /sample/src/main/res/mipmap-xhdpi/ic_launcher.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/gsrathoreniks/Scratchify/214e95366ddd711c47db7be58be8e16f5feddefa/sample/src/main/res/mipmap-xhdpi/ic_launcher.webp -------------------------------------------------------------------------------- /sample/src/main/res/mipmap-xhdpi/ic_launcher_round.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/gsrathoreniks/Scratchify/214e95366ddd711c47db7be58be8e16f5feddefa/sample/src/main/res/mipmap-xhdpi/ic_launcher_round.webp -------------------------------------------------------------------------------- /sample/src/main/res/mipmap-xxhdpi/ic_launcher.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/gsrathoreniks/Scratchify/214e95366ddd711c47db7be58be8e16f5feddefa/sample/src/main/res/mipmap-xxhdpi/ic_launcher.webp -------------------------------------------------------------------------------- /sample/src/main/res/mipmap-xxhdpi/ic_launcher_round.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/gsrathoreniks/Scratchify/214e95366ddd711c47db7be58be8e16f5feddefa/sample/src/main/res/mipmap-xxhdpi/ic_launcher_round.webp -------------------------------------------------------------------------------- /sample/src/main/res/mipmap-xxxhdpi/ic_launcher.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/gsrathoreniks/Scratchify/214e95366ddd711c47db7be58be8e16f5feddefa/sample/src/main/res/mipmap-xxxhdpi/ic_launcher.webp -------------------------------------------------------------------------------- /sample/src/main/res/mipmap-xxxhdpi/ic_launcher_round.webp: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/gsrathoreniks/Scratchify/214e95366ddd711c47db7be58be8e16f5feddefa/sample/src/main/res/mipmap-xxxhdpi/ic_launcher_round.webp -------------------------------------------------------------------------------- /sample/src/main/res/values/colors.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | #FFBB86FC 4 | #FF6200EE 5 | #FF3700B3 6 | #FF03DAC5 7 | #FF018786 8 | #FF000000 9 | #FFFFFFFF 10 | -------------------------------------------------------------------------------- /sample/src/main/res/values/strings.xml: -------------------------------------------------------------------------------- 1 | 2 | Sample 3 | -------------------------------------------------------------------------------- /sample/src/main/res/values/themes.xml: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 |