Installation

FMTC is licensed under GPL-v3.

If you're developing an application that isn't licensed under GPL, this affects you and your application's legal right to distribution. For more information, please see (Proprietary) Licensing.

Looking to start using FMTC in your project? Check out the Quickstart guide!

Install

from pub.dev

For the latest stable release, depend on the package as you normally would by adding it to your pubspec.yaml manually or using:

flutter pub add flutter_map_tile_caching

from GitHub directly

Then, depending on the platforms you are developing for, you may need to follow ObjectBox's installation instructions for your platform (which can be found originally here, under the Flutter tab):

Android

Try building the app - it might just work, especially if you are using other plugins in your app!

If it does not build successfully

If the error message seems to indicate that the "Android NDK" version needs to be higher, follow the instructions.

Usually this involves the following change to your app-level build.gradle(.kts) config:

android/app/build.gradle(.kts)

android {
    namespace = "*"
    compileSdk = flutter.compileSdkVersion
-   ndkVersion = flutter.ndkVersion
+   ndkVersion = <the version specified at the end of the error log>

    ...
}

macOS

Web (unsupported)

Import

After installing the package, import it into the necessary files in your project:

import 'package:flutter_map_tile_caching/flutter_map_tile_caching.dart';