Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 5 additions & 26 deletions documentation/docs/00-getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,37 +2,18 @@

## Installation from Unity Package

1. Visit https://www.mapbox.com/unity/

2. Click `Download the SDK`

3. If you already have a Mapbox SDK imported in your project, please delete the existing `Mapbox` folder to avoid potential conflicts

4. Import the package in Unity

- Assets—>Import package—>Custom Package (from the Unity editor menu)

**OR**

- Double-click downloaded `.unityPackage`
Check out the official [Unity SDK page](https://www.mapbox.com/unity-sdk/) for installation steps.

## Installation from Git (source)

1. `git clone https://github.com/mapbox/mapbox-unity-sdk.git`
2. [Read about how the project is configured](https://github.com/mapbox/mapbox-unity-sdk/blob/develop/README.md) and [learn how to contribute](https://github.com/mapbox/mapbox-unity-sdk/blob/develop/CONTRIBUTING.md)
3. The actual Unity project is nested in the `sdkproject` directory

## Configure your Mapbox API Token

You need an [access token](https://www.mapbox.com/help/define-access-token) to use your Mapbox account's capabilities.

- [Get a Mapbox API token and add it to your Unity project](01-mapbox-api-token.md)
2. [Run the update script](https://github.com/mapbox/mapbox-unity-sdk/blob/develop/README.md#from-this-repository-advanced-latest-development).
3. [Read about how the project is configured](https://github.com/mapbox/mapbox-unity-sdk/blob/develop/README.md) and [learn how to contribute](https://github.com/mapbox/mapbox-unity-sdk/blob/develop/CONTRIBUTING.md)
4. The actual Unity project is nested in the `sdkproject` directory

## Next Steps

- Follow along with [these tutorials](https://www.mapbox.com/unity-sdk/tutorials)
- Explore the [bundled Unity examples](03-examples.md)
- Learn about the [Map Factory Framework](06-map-factory-framework.md)
- Read the [Unity/C# API documentation](https://www.mapbox.com/mapbox-unity-sdk/api/)

## Explore
Expand All @@ -51,6 +32,4 @@ Before reporting issues or contacting support, please follow these steps:
2. Read about [Known Issues](02-known-issues.md)
3. Check our [public respository for existing issues](https://github.com/mapbox/mapbox-unity-sdk/issues)



If you still need help, please [contact support](https://www.mapbox.com/contact/) or [create an issue](https://github.com/mapbox/mapbox-unity-sdk/issues).
If you still need help, please [contact support](https://www.mapbox.com/contact/) or [create an issue](https://github.com/mapbox/mapbox-unity-sdk/issues).
13 changes: 0 additions & 13 deletions documentation/docs/01-mapbox-api-token.md

This file was deleted.

2 changes: 0 additions & 2 deletions documentation/docs/02-known-issues.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,5 +34,3 @@
### Tile Error Callbacks

- When a client sends a `Cancel()` / `Recycle()` request to a `UnityTile` instance, the `OnTileError` event handler method is unsubscribed from the `OnTileError` event. Followed by that, a "request aborted" exception is sent as a part of the response to the requested `Tile`. But, the `UnityTile` instance cannot listen to this exception since, it has already unsubscribed from the `OnTileError` event


120 changes: 0 additions & 120 deletions documentation/docs/03-examples.md

This file was deleted.

7 changes: 0 additions & 7 deletions documentation/docs/04-attribution.md

This file was deleted.

2 changes: 1 addition & 1 deletion documentation/docs/05-changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@
- `MapId` and `Factories` are now public so that you can change them at runtime.

##### New Examples
- [See here for the latest.](https://www.mapbox.com/mapbox-unity-sdk/docs/03-examples.html)
- [See here for the latest.](https://www.mapbox.com/unity-sdk)

### v.1.1.0

Expand Down
27 changes: 0 additions & 27 deletions documentation/docs/06-map-factory-framework.md

This file was deleted.

28 changes: 14 additions & 14 deletions documentation/docs/hololens-development.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# HoloLens development

> [!NOTE]
> Refer to [Exporting to Windows Store (UWP, HoloLens)](windowsstore-uwp-hololens.md) to meet the `sqlite3` requirement for `Windows Store` solutions.
-> [!NOTE]
-> Refer to [Exporting to Windows Store (UWP, HoloLens)](windowsstore-uwp-hololens.md) to meet the `sqlite3` requirement for `Windows Store` solutions.

HoloLens requires code/assemblies to work with [Universal Windows Platform (UWP)](https://developer.microsoft.com/en-us/windows/apps).

Expand All @@ -15,15 +15,15 @@ Reference: [dev.microsoft.com: Unity development overview, Configuring a Unity p
![image](images/hololens/hololens-main-camera.png)

* File -> Build Settings -> Windows Store
* `SDK` => `Universal 10`
* `Build Type` => `D3D`
* `Player Settings` => `Settings for Windows Store` tab
* `Other Settings` => `Rendering`:
* **!!!check checkbox `Virtual Reality Supported` to add a new `Virtual Reality Devices` list and confirm `Windows Holographic` is listed as supported device!!**
* `Publish Settings` => `Capabilities`:
* check `SpatialPerception`
* **!!!check `InternetClient`!!!**

* Edit -> Project Settings -> Quality
* select dropdown under `Windows Store` logo to `Fastest`
![image](images/hololens/hololens-projectsettings-qualitysettings.png)
* `SDK` => `Universal 10`
* `Build Type` => `D3D`
* `Player Settings` => `Settings for Windows Store` tab
* `Other Settings` => `Rendering`:
* **!!!check checkbox `Virtual Reality Supported` to add a new `Virtual Reality Devices` list and confirm `Windows Holographic` is listed as supported device!!**
* `Publish Settings` => `Capabilities`:
* check `SpatialPerception`
* **!!!check `InternetClient`!!!**
* Edit -> Project Settings -> Quality
![image](images/hololens/hololens-projectsettings-qualitysettings.png)
* select dropdown under `Windows Store` logo to `Fastest`
23 changes: 10 additions & 13 deletions documentation/docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,19 +35,16 @@ footer{
<div class="row">
<div class="col-md-8 col-md-offset-2 text-left">
<p>
<b>Quick start links: </b> <br>
<ul>
<li>[Getting started](00-getting-started.md) </li> <br>
<li>[Mapbox API Token](01-mapbox-api-token.md) </li> <br>

<li>[Changelog](05-changelog.md) </li><br>

<li>[Known issues](02-known-issues.md) </li><br>
<li>[Examples](03-examples.md) </li><br>
<li>[API Documentation](api/) </li><br>
</ul>

</p>
<b>Quick start links: </b> <br>
<ul>
<li>[Getting started](00-getting-started.md) </li> <br>
<li>[Changelog](05-changelog.md) </li><br>
<li>[Known issues](02-known-issues.md) </li><br>
<li>[API Documentation](api/) </li><br>
<li>[Unity SDK page](https://www.mapbox.com/unity-sdk/)</li>
</ul>

</p>

</div>
</div>
Expand Down
16 changes: 2 additions & 14 deletions documentation/docs/toc.yml
Original file line number Diff line number Diff line change
@@ -1,26 +1,14 @@
- name: Getting Started
href: 00-getting-started.md

- name: Mapbox API Token
href: 01-mapbox-api-token.md

- name: Known Issues
href: 02-known-issues.md

- name: Examples
href: 03-examples.md

- name: Attribution
href: 04-attribution.md

- name: Changelog
href: 05-changelog.md

- name: Map Factory Framework
href: 06-map-factory-framework.md
href: 05-changelog.md

- name: Windows Store, UWP, HoloLens
href: windowsstore-uwp-hololens.md

- name: HoloLens Development
href: hololens-development.md
href: hololens-development.md
2 changes: 1 addition & 1 deletion documentation/docs/windowsstore-uwp-hololens.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,4 @@ This SDK has a dependency on `sqlite` which has to be installed seperately after
* Click `Extensions`
* Check `SQLite for Universal Windows Platform`

The `Windows Store` solution should build successfully now.
The `Windows Store` solution should build successfully now.
6 changes: 0 additions & 6 deletions sdkproject/Assets/Mapbox/README.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,10 @@ Thank you for downloading the Mapbox Unity SDK (for Unity 2017.1+)!

Getting started: https://www.mapbox.com/mapbox-unity-sdk/docs/00-getting-started.html

Configuring your API token: https://www.mapbox.com/mapbox-unity-sdk/docs/01-mapbox-api-token.html

Tutorials: https://www.mapbox.com/unity-sdk/tutorials/

Built-in Examples: https://www.mapbox.com/mapbox-unity-sdk/docs/03-examples.html

Known Issues: https://www.mapbox.com/mapbox-unity-sdk/docs/02-known-issues.html

Attribution: https://www.mapbox.com/mapbox-unity-sdk/docs/04-attribution.html

API: https://www.mapbox.com/mapbox-unity-sdk/api/


Expand Down
3 changes: 1 addition & 2 deletions sdkproject/Assets/Mapbox/Unity/MapboxAccess.cs
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,7 @@ public static MapboxAccess Instance

MapboxConfiguration _configuration;
/// <summary>
/// The Mapbox API access token.
/// See <see href="https://www.mapbox.com/mapbox-unity-sdk/docs/01-mapbox-api-token.html">Mapbox API Congfiguration in Unity</see>.
/// The Mapbox API access token.
/// </summary>
public MapboxConfiguration Configuration
{
Expand Down