# Getting Started
New version
From version 5, Photo Sphere Viewer is now available under the name @photo-sphere-viewer/core an other sub-packages. If you are using the previous photo-sphere-viewer package, please follow the migration guide. You can also read the version 4 documentation (opens new window).
Playground
Test Photo Sphere Viewer with you own panorama in the Playground
# Install Photo Sphere Viewer
# With npm or yarn
npm install @photo-sphere-viewer/core
yarn add @photo-sphere-viewer/core
# Via CDN
Photo Sphere Viewer is available on jsDelivr (opens new window)
# Manually
You can also download the latest release (opens new window)
# Dependencies
- Three.js (opens new window) (use
build/three.min.jsfile)
# Your first viewer
Include all JS & CSS files in your page manually or with your favorite bundler and init the viewer.
The panorama must be an equirectangular projection (opens new window) of your photo. Other modes are supported through adapters.
Cropped panoramas
If your image is not covering a full 360°×180° sphere, it will be deformed. You can fix it by providing cropping data.