Transforms app settings management with type-safe configuration, zero boilerplate, and auto-generated admin UI. Supports annotations, compile-time validation, and multiplatform compatibility.
AppConfig is a powerful, type-safe configuration management library for Kotlin Multiplatform that transforms how you handle app settings with zero boilerplate code. Define your configuration as simple interfaces and let KSP generate all the boring stuff.
// Android - SharedPreferences hell
val prefs = context.getSharedPreferences("settings", Context.MODE_PRIVATE)
val isDarkMode = prefs.getBoolean("is_dark_mode_enabled", false)
prefs.edit().putBoolean("is_dark_mode_enabled", true).apply()
// iOS - NSUserDefaults pain
val userDefaults = NSUserDefaults.standardUserDefaults
val isDarkMode = userDefaults.boolForKey("is_dark_mode_enabled")
userDefaults.setBool(, forKey = )
@Config(groupName = "UserSettings")
interface UserSettings {
@BooleanProperty(defaultValue = false, description = "Enable dark mode")
var isDarkModeEnabled: Boolean
@StringProperty(defaultValue = "https://api.example.com", description = "API endpoint")
var apiEndpoint: String
}
// Usage - pure magic ✨
settings = AppConfig.usersettings
settings.isDarkModeEnabled =
less code. 100% type safety. Works everywhere.
// build.gradle.kts
plugins {
id("com.google.devtools.ksp") version "CURRENT_KSP_VERSION"
id("io.github.mambawow.appconfig") version "0.0.3-alpha03"
}
kotlin {
sourceSets {
commonMain.dependencies {
implementation("io.github.mambawow.appconfig:appconfig-lib:0.0.3-alpha03")
// Optional: Admin UI panel
implementation("io.github.mambawow.appconfig:appconfig-panel:0.0.3-alpha03")
}
}
}
@Config(groupName = "UserSettings")
interface UserSettings {
@BooleanProperty(defaultValue = false, description = "Enable dark mode")
var isDarkModeEnabled: Boolean
@StringProperty(defaultValue = "https://api.example.com", description = "API base URL")
var apiEndpoint: String
@IntProperty(defaultValue = 30, description = )
timeoutSeconds:
}
// Access your configuration anywhere in your app
val settings = AppConfig.usersettings
// Read values
println("Dark mode: ${settings.isDarkModeEnabled}")
println("API: ${settings.apiEndpoint}")
// Update values (automatically persisted across platforms!)
settings.isDarkModeEnabled = true
settings.timeoutSeconds = 60
@Composable
fun DebugScreen() {
ConfigPanel(
configItems = AppConfig.getAllConfigItems()
)
}
Perfect for QA teams to test different configurations without rebuilding the app!
Define configurations that only exist on specific platforms:
{
isCameraXEnabled:
useMaterialYou:
}
{
enableHaptics:
useAlternateIcons:
}
AppConfig automatically detects the source set and generates code only for the target platform!
@Config
{
onboardingGroup: OnboardingGroup
}
{
Tutorial : OnboardingGroup()
Demo : OnboardingGroup()
Skip : OnboardingGroup()
}
experiment = AppConfig.experimentconfig
(experiment.onboardingGroup) {
OnboardingGroup.Tutorial -> showTutorial()
OnboardingGroup.Demo -> showDemo()
OnboardingGroup.Skip -> skipOnboarding()
}
No more wondering what "variant_2" means six months later!
AppConfig uses Kotlin Symbol Processing (KSP) to generate all the boilerplate at compile time:
┌─────────────────┐ KSP ┌──────────────────┐
│ @Config │ ────────→ │ Generated │
│ Interface │ │ Implementation │
└─────────────────┘ └──────────────────┘
│
▼
┌─────────────────┐ ┌──────────────────┐
│ Platform │ ←──────────│ ConfigStore │
│ Storage │ │ Abstraction │
└─────────────────┘ └──────────────────┘
What gets generated:
AppConfig.usersettings)@Config
interface ShoppingConfig {
@BooleanProperty(defaultValue = false)
var enableOneClickCheckout: Boolean
@OptionProperty(description = "Checkout flow variant")
var checkoutVariant: CheckoutVariant
@IntProperty(defaultValue = 5)
var maxCartItems: Int
}
@Config
interface SocialConfig {
@BooleanProperty(defaultValue = true)
var enableStories: Boolean
@BooleanProperty(defaultValue = false)
var enableLiveStreaming: Boolean
@OptionProperty(description = "Feed algorithm")
var feedAlgorithm: FeedAlgorithm
}
This project is licensed under the MIT License - see the LICENSE file for details.
| Annotation | Kotlin Type | Description | Use Case |
|---|
@StringProperty | String | Text values | API URLs, user names |
@BooleanProperty | Boolean | True/false toggles | Feature flags, preferences |
@IntProperty | Int | 32-bit integers | Timeouts, retry counts |
@LongProperty | Long | 64-bit integers | Timestamps, large numbers |
@FloatProperty | Float | 32-bit floating point | Animation speeds, ratios |
@DoubleProperty | Double | 64-bit floating point | Precise calculations |
@OptionProperty | Sealed Class | Enum-like choices | A/B test groups, themes |
| Module | Purpose | When to Use |
|---|
appconfig-annotation | Core annotations | Always (automatically included) |
appconfig-processor | KSP processor | Always (automatically included) |
appconfig-lib | Runtime library | Always |
appconfig-panel | Admin UI | Optional (debugging, A/B testing) |
appconfig-gradle-plugin | Build tools | Always (automatically applied) |
Surfaced from shared tags and platforms — no rankings paid for.