# Mergin Maps QGIS Plugin Overview

The Mergin Maps QGIS plugin allows you to work with your Mergin Maps projects in QGIS, whether it's downloading the project to your computer, making changes in the project, seeing the project's status or synchronising changes to the cloud.

To get started, you will need to install and configure the plugin.

Once installed, plugin's entries will be added to the QGIS toolbar panel, Browser panel, Project properties and to the Processing toolbox.

Upgrade the plugin regularly

To ensure you can use the latest improvements, don't forget to upgrade the plugin whenever there is an update available!

# Mergin Maps toolbar in QGIS

The Mergin Maps toolbar is added to the QGIS toolbars panel after installation.
Mergin Maps Plugin Toolbar in QGIS

It contains following buttons:

If you don't see Mergin Maps toolbar, make sure it is enabled in QGIS toolbars panel
Enabling Mergin Maps plugin in QGIS toolbars panel

# Mergin Maps plugin in QGIS Browser

Once you have installed the QGIS plugin and configured it with your Mergin Maps credentials, you should be able to see it in your QGIS Browser panel.

The name of the current workspace is displayed in the square brackets (here: sarah) and available projects are listed underneath.
List of Mergin Maps projects in QGIS Browser

Right-click on the workspace name to easily access options to configure the plugin, refresh, create new project, find a project in your workspace, switch workspace or explore public projects.

Mergin Maps in QGIS browser

# Downloading a project in QGIS

TIP

Detailed steps on how to download and open your Mergin Maps project are included in the Opening Surveyed Data on Your Computer tutorial.

  1. Right-click on a project in the Browser panel and select Download
    Download Mergin Maps project option in QGIS browser

  2. Browse to the folder, where you want to save the project and click Select folder. The project will be downloaded here.

    WARNING

    Do not use shared network drives or cloud storage (such as OneDrive or Google Drive) to store your Mergin Maps projects. It is not supported and can cause errors.

  3. Once the download is completed, you will have the option to open the project in QGIS.

# Exploring public projects

  1. Right-click on the Mergin Maps entry in the QGIS Browser and select the Explore public projects option
    Explore public projects in QGIS Browser

  2. Find the project you are interested in. Use the search bar to limit the choices.
    List of public projects in QGIS Browser

  3. Select the project and click Open project. Browse to the folder where you want to save the project. The project will be downloaded here.

TIP

You can package this downloaded project using Mergin Maps QGIS plugin as described in Create a project in QGIS using the Package current QGIS project option and use it as your own Mergin Maps project.

# Mergin Maps Project Properties

Some settings of your Mergin Maps project can be done through QGIS Documentation Project Properties (opens new window), such as:

Mergin Maps Project Properties in QGIS

# Mergin Maps Tools in QGIS Processing Toolbox

Processing is a core plugin of QGIS. By installing Mergin Maps QGIS plugin, Mergin Maps tools are added to the QGIS Documentation Processing Toolbox (opens new window).

Use the Toolbox icon in the toolbar panel to display Processing Toolbox in QGIS.
Mergin Maps tools in QGIS processing toolbox

# Create diff (Processing toolbox)

Create diff is a tool that extracts changes made between two versions of a layer in your Mergin Maps project to make it easier to revise changes.

  1. Navigate to Mergin Maps tools in the Processing toolbox in QGIS

  2. Double click the Create diff tool and fill in the parameters in the dialog window. Click Run.
    Create diff tool dialog

  3. The diff layer is added to the Layers panel. Changes are visualised on the map and also in the attribute table of the layer.
    Diff layer added to QGIS layers panel

# Create report (Processing toolbox)

Create report tool provides an overview of changes in your Mergin Maps project for a range of project versions. The output is a CSV file, which can be opened in QGIS and also in common text and spreadsheets programs.

  1. Navigate to Mergin Maps tools in the Processing toolbox in QGIS

  2. Double click the Create report tool.

    Fill in the parameters in the dialog window. If you want to get the report for a specified range of versions, define also the start and end version.

    Click Run.
    Create report tool dialog

  3. The report is added to the Layers panel.
    Create report tool result

# Download vector tiles (Processing toolbox)

This tool can be used to easily download vector tiles for offline use. Go to Downloading vector tiles using Mergin Maps QGIS plugin to see how it works.

# Extract local changes (Processing toolbox)

Local changes of a specific layer can also be extracted using the Extract local changes tool in the Processing toolbox.

  1. Navigate to Mergin Maps tools in the Processing toolbox in QGIS

  2. Double click the Extract local changes tool. In the dialog window, enter your project directory and select the input layer. The output local changes layer can be saved as a file or as a temporary file. Click Run.
    QGIS extract local changes tool

  3. The local changes layer is added to the Layers panel
    Local changes added to QGIS project

# Mergin Maps in QGIS Plugins menu bar

Plugins menu bar in QGIS contains also Mergin Maps options: