Skip to content

Commit 5401f98

Browse files
karimnaajitallytalwar
authored andcommitted
Add minimal README (#65)
1 parent e2711cd commit 5401f98

File tree

2 files changed

+29
-0
lines changed

2 files changed

+29
-0
lines changed

README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
Tangram Unity
2+
=============
3+
4+
5+
![screenshot](tangram-unity.png)
6+
7+
Tools for using Mapzen vector tiles in the Unity engine. The repository contains the assets and main plugin to design and generate a map region to be used in your Unity scene.
8+
9+
Quickstart
10+
-----------
11+
12+
1. Create a [Mapzen API Key](https://mapzen.com/developers/sign_up)
13+
2. Open the Unity plugin project
14+
4. Drag and drop `Assets/Mapzen.prefab` in a Unity scene
15+
4. Create a new _style_ to selectively generate and filter data for your map region: Assets > Create > Mapzen > Style
16+
5. Start authoring the style by adding filters to select map layers and associate them with materials
17+
6. Select the game object `Mapzen`
18+
- Add your API key created in 1.
19+
- Reference the newly created style asset in `Feature styling`
20+
- Give a a region name
21+
- Hit the `Download` button
22+
23+
Roadmap
24+
-------
25+
26+
- Terrain support
27+
- Tile streaming
28+
- Map data access from game objects
29+

tangram-unity.png

726 KB
Loading

0 commit comments

Comments
 (0)