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!

Depend On

From pub.dev

This is the recommended method of installing this package as it ensures you only receive the latest stable versions, and you can be sure pub.dev is reliable.

Just import the package as you would normally, from the command line:

flutter pub add flutter_map_tile_caching

From github.com

If you urgently need the latest version, a specific branch, or a specific fork, you can use this method.

Commits available from Git (GitHub) may not be stable. Only use this method if you have no other choice.

First, add the normal dependency following the From pub.dev instructions. Then, add the following lines to your pubspec.yaml file under the dependencies_override section:

pubspec.yaml

dependency_overrides:
    flutter_map_tile_caching:
        git:
            url: https://github.com/JaffaKetchup/flutter_map_tile_caching.git
            # ref: a commit hash, branch name, or tag (otherwise defaults to master)

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';
// You'll also need to import flutter_map and (likely) latlong2 seperately

Also ensure you've followed flutter_map's installation instructions!

Installationflutter_map Documentation

Although FMTC will compile on the web, the default FMTCObjectBoxBackend (see Backends) does not support the web platform: the initialise and uninitialise methods (see Initialisation) will throw UnsupportedErrors, and other methods will throw RootUnavailable.