Skip to content

Commit f231be1

Browse files
authored
GE-823 pre release (#163)
* GE-823 Update READme * GE-823 Update READme
1 parent 8092109 commit f231be1

File tree

9 files changed

+53
-12
lines changed

9 files changed

+53
-12
lines changed

README.md

Lines changed: 48 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,8 @@ Homepage: [https://www.maptiler.com/qgis-plugin/](https://www.maptiler.com/qgis-
1212
- [Requirements](#requirements)
1313
- [Feature & Usage](#feature--usage)
1414
- [Add background maps to a project](#add-background-maps-to-a-project)
15-
- [Vector and raster tiles](#vector-and-raster-tiles)
1615
- [Load a map in Mapbox GL JSON format](#load-a-map-in-mapbox-gl-json-format)
16+
- [Vector and raster tiles](#vector-and-raster-tiles)
1717
- [Customize quickly the look&feel of the base maps ](#customize-quickly-the-lookfeel-of-the-base-maps)
1818
- [Geocoding / place search](#geocoding--place-search)
1919
- [Access key](#access-key)
@@ -22,7 +22,7 @@ Homepage: [https://www.maptiler.com/qgis-plugin/](https://www.maptiler.com/qgis-
2222

2323
<!-- /TOC -->
2424

25-
## Instalation
25+
## Installation
2626

2727
There are two ways to install this plugin.
2828

@@ -39,25 +39,35 @@ Then MapTiler should be added to your QGIS Browser.
3939

4040
For plugin version 2.0, you need QGIS 3.16 or higher.
4141

42-
---
42+
For plugin version 3.0, you need QGIS 3.24 or higher.
4343

44-
## Feature & Usage
44+
### Fonts
4545

46-
### Load a map in Mapbox GL JSON format
46+
Maps from MapTiler Cloud use various fonts. You might get similar warnings in QGIS.
4747

48-
You can add your own map from the tab `From URL`. Add the name of your map and URL to JSON.
48+
<img src='imgs/readme_09.png'>
4949

50-
For **vector tiles** you can add either URL to style.json or TileJSON. Note that if you add URL to TileJSON you will get only tiles data with basic QGIS styling. For **raster tiles** you have to add URL to TileJSON.
50+
If you want display these maps in QGIS, you need to have these fonts
51+
installed on your system. QGIS will use a default font if specific font is not installed on your system.
5152

52-
<img src='imgs/readme_07.png'>
5353

54+
List of fonts used in maps at MapTiler Cloud can be found at
55+
[https://api.maptiler.com/fonts.json](https://api.maptiler.com/fonts.json).
56+
57+
58+
---
59+
60+
## Feature & Usage
5461

5562
### Add background maps to a project
5663

5764
MapTiler plugin provides several preset maps. Some of them are visible from QGIS Browser.
5865
- Basic
5966
- Bright
67+
- OpenStreetMap
68+
- Outdoor
6069
- Satellite
70+
- Terrain RGB
6171
- Toner
6272
- Topo
6373
- Voyager
@@ -67,6 +77,15 @@ More maps are available after you click on `Add a new map...` from MapTiler plug
6777
<img src='imgs/readme_06.png'>
6878

6979

80+
### Load a map in Mapbox GL JSON format
81+
82+
You can add your own map from the tab `From URL`. Add the name of your map and URL to JSON.
83+
84+
For **vector tiles** you can add either URL to style.json or TileJSON. Note that if you add URL to TileJSON you will get only tiles data with basic QGIS styling. For **raster tiles** you have to add URL to TileJSON.
85+
86+
<img src='imgs/readme_07.png'>
87+
88+
7089
### Vector and raster tiles
7190

7291
MapTiler plugin supports loading maps via both vector and raster tiles. You can choose from the contextual menu of the map and clicking either on `Add as Raster` or `Add as Vector`.
@@ -75,6 +94,7 @@ You can choose the default type of tiles by checking/unchecking `Use vector tile
7594

7695
Vector tiles support requires QGIS 3.13 or higher.
7796
For the plugin version 2.0 and higher you need QGIS 3.16 or higher.
97+
For the plugin version 3.0 and higher you need QGIS 3.24 or higher.
7898

7999
You can read about the difference between vector and raster tiles here [https://www.maptiler.com/news/2019/02/what-are-vector-tiles-and-why-you-should-care/](https://www.maptiler.com/news/2019/02/what-are-vector-tiles-and-why-you-should-care/?utm_source=github.com&utm_medium=referral&utm_campaign=qgis-plugin)
80100

@@ -87,6 +107,13 @@ Switch language, select layers, and change colors to match your brand and make a
87107

88108
“Save” this map, and add it via URL - by copy&pasting the link to “GL JSON Style” from the Cloud page of the map.
89109

110+
### Global Digital Elevation Model (DEM)
111+
The plugin offers elevation model (DEM) for the entire planet.
112+
You can use the layer for hillshading, hypsometry, analytical applications, and even 3D terrain modeling.
113+
114+
<img src='imgs/readme_10.gif'>
115+
116+
90117
### Geocoding / place search
91118

92119
MapTiler plugin also provides MapTiler toolbar for basic geocoding / place search.
@@ -98,7 +125,19 @@ When you click on one place in the list, the map canvas will zoom to feature ext
98125

99126
<img src='imgs/readme_04.png'>
100127

101-
### Access key
128+
### Authentication
129+
#### Credentials (for plugin version 3.0 and higher)
130+
The plugin version 3.0 and higher uses credentials for authentication in MapTiler Cloud.
131+
You can get your own FREE credentials at [https://cloud.maptiler.com/account/credentials](https://cloud.maptiler.com/account/credentials/?utm_source=qgis&utm_medium=product&utm_campaign=qgis-plugin)
132+
133+
<img src='imgs/readme_11.png'>
134+
135+
Click on `Account...` from MapTiler plugin contextual menu to open the Account dialog window and to insert your token.
136+
137+
<img src='imgs/readme_08.png'>
138+
139+
140+
#### Access key (for older versions)
102141

103142
This plugin needs your access key to the MapTiler Cloud that is available for free.
104143
You can get your own FREE access key at [https://cloud.maptiler.com/account/keys](https://cloud.maptiler.com/account/keys?utm_source=github&utm_medium=product&utm_campaign=qgis-plugin)

imgs/readme_01.png

9.02 KB
Loading

imgs/readme_06.png

-5.14 KB
Loading

imgs/readme_07.png

-1.29 KB
Loading

imgs/readme_08.png

32.4 KB
Loading

imgs/readme_09.png

107 KB
Loading

imgs/readme_10.gif

3.28 MB
Loading

imgs/readme_11.png

106 KB
Loading

metadata.txt

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,18 @@
44

55
[general]
66
name=MapTiler
7-
qgisMinimumVersion=3.16
7+
qgisMinimumVersion=3.24
88
description=Street and satellite base maps with vector tiles
9-
version=2.0.0
9+
version=3.0.0
1010
author=MapTiler
1111
email=info@maptiler.com
1212

1313
about=- Beautiful base maps using OpenStreetMap data powered by vector tiles - served from MapTiler Cloud.
1414

1515
- Satellite map of the entire world, outdoor map, hillshading and landcover, Ordnance Survey Open ZoomStack, Dutch Kadaster via Cartiqo, or GSI data in Japan - or your own datasets!
1616

17+
- Global digital elevation model (DEM) for the entire planet.
18+
1719
- Customize language & colors of your map with a few clicks!
1820

1921
- Import your own Mapbox GL JSON style or TileJSON from any URL - even hosted on your own server.
@@ -31,7 +33,7 @@ hasProcessingProvider=no
3133
# changelog=
3234

3335
# Tags are comma separated with spaces allowed
34-
tags=maptiler, open, map, maps, tiles, openmaptiles, osm, openstreetmap, raster, vector, wmts, tilejson, mapbox, gl, style, styles, geocoding, basemaps, quickmapservices, vector-tiles, geojson, reader, xyz, print, ordnance survey, zoomstack, kadaster, cartiqo, gsi, japan, outdoor
36+
tags=maptiler, open, map, maps, tiles, openmaptiles, osm, openstreetmap, raster, vector, wmts, tilejson, mapbox, gl, style, styles, geocoding, basemaps, quickmapservices, vector-tiles, geojson, reader, xyz, print, ordnance survey, zoomstack, kadaster, cartiqo, gsi, japan, outdoor, carto, dem, digital, elevation, model
3537

3638
homepage=https://maptiler.link/qgisplugin
3739
category=Web

0 commit comments

Comments
 (0)