# Getting started

## Instructions

### Installation

Choose [Krpano ](https://krpano.com/)or [A-frame](https://aframe.io/) as your panorama viewer and include its script (it should be placed before `vrmaker-sdk.js`).

{% hint style="info" %}
If you want to use Krpano as your viewer, you can use the free version with watermark to demo. Otherwise, you need to purchase a Krpano license.
{% endhint %}

```markup
// purchase a KRPano license and use the paid version of the JS file in your project
<script type=text/javascript src="krpano.min.js"></script>
```

Then import vrmaker by es6 in your project.

```
import VRViewer from 'vrviewer'
```

Or use [VR Maker SDK cdn ](https://www.istaging.com/sdk/vrmaker.js)include it in your project:

```javascript
<script src="https://www.istaging.com/sdk/vrviewer.js"></script>
```

Finally, initialize the `VRMaker` object (don't forget do create a `div` with an `id`):

```markup
<body>
  <div id="vrviewer"></div>
</body>

<script>
var vrviewer = new VRViewer()
vrviewer.init({
  el: '#vrviewer-sdk',
  lang: 'zh-cn',
  panoCollection: fakePanoCollection,
  panoramas: fakePanoramas,
  setting: {
    autoRotateSetting: {
      active: true,
      revert: false,
      rotateDuration: 200000,
      restartTime: 20000
    },
    gyroSetting: {
      active: false
    },
    krpanoSetting: {
      mwheel: true,
      focus: false
    },
    tripodSetting: {
      image: 'https://www.istaging.com/sdk/logo-tripod.png',
      size: 60
    }
  }
})
</script>
```

{% hint style="info" %}
You can also hard-code the panorama Array. For example:

```
panoramas: [{
  panoramaId: '1',
  panoramaName: 'a', 
  panoramaIndex: 0
  downloadLink: 'example.png',
  panoramaRotation: 0
}, {
  panoramaId: '2',
  // etc ...
}]
```

{% endhint %}

### Result

![](https://1431315220-files.gitbook.io/~/files/v0/b/gitbook-legacy-files/o/assets%2F-L98J_D4LLzOy-YFZgiO%2F-LABH3WV73C6iRxmhc4l%2F-LABHTxivpcAQVujZXub%2Fdownload%20\(3\).png?alt=media\&token=287ad9c6-b9c3-4c65-828d-0cac6ed0d564)

### Example

Clone <https://github.com/istagingRD/vrmaker-sdk> and check it in examples / src folder.

```
npm install

npm start

// You can also check webpack dev server
npm run dev
```

### Live example

<https://livetour.istaging.com/58217f61a22b9d0067e06d7c?ui=true>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://istaging.gitbook.io/vr-maker-sdk/getting-started.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
