Skip to content

Commit 25202ee

Browse files
committed
Initial Commit
0 parents  commit 25202ee

File tree

5 files changed

+987
-0
lines changed

5 files changed

+987
-0
lines changed

CITATION.cff

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
abstract: "360 degree image and video viewer"
2+
authors:
3+
- family-names: Egan
4+
given-names: Ben
5+
cff-version: 1.2.0
6+
date-released: "2025-05-12"
7+
keywords:
8+
- "image viewer"
9+
- "video player"
10+
- 360
11+
- panorama
12+
- equirectangular
13+
- viewer
14+
- "360 degrees"
15+
- "360 degree image"
16+
- research
17+
license: MIT
18+
message: "If you use this software, please cite it using these metadata."
19+
repository-code: "https://github.com/ProGamerGov/html-360-viewer"
20+
title: "Browser-Based Viewer for 360 Images and Videos"

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2025 Ben Egan
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

ReadMe.md

Lines changed: 97 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,97 @@
1+
# 360° Image & Video Viewer
2+
3+
A lightweight, browser-based viewer for 360-degree images and videos. No additional setup required, just open the HTML file in any modern browser.
4+
5+
6+
<div align="left">
7+
<img src="examples/example_image.png" width="710px">
8+
</div>
9+
10+
Try it out here: https://progamergov.github.io/html-360-viewer
11+
12+
Supports:
13+
14+
* 360° panoramic **images**, most formats supported by browsers, like [JPEG](https://en.wikipedia.org/wiki/JPEG) (includes '.jpg'), [PNG](https://en.wikipedia.org/wiki/PNG), [WebP](https://en.wikipedia.org/wiki/WebP), etc.
15+
* 360° **videos** in [.mp4](https://en.wikipedia.org/wiki/MP4_file_format) and [.webm](https://en.wikipedia.org/wiki/WebM) format. Works as a 360 video player.
16+
* Monoscopic 360 images and stereo images in **top-bottom** and **left-right** layouts
17+
18+
19+
## 🧪 Compatibility
20+
21+
Work on all major web browsers that [A-Frame](https://aframe.io/docs/1.7.0/introduction/faq.html) supports.
22+
23+
* [Firefox](https://en.wikipedia.org/wiki/Firefox)
24+
* [Chrome](https://en.wikipedia.org/wiki/Google_Chrome) (including Chromium based browsers like [Brave](https://en.wikipedia.org/wiki/Brave_(web_browser)) & [Opera](https://en.wikipedia.org/wiki/Opera_(web_browser)))
25+
* [Microsoft Edge](https://en.wikipedia.org/wiki/Microsoft_Edge)
26+
* [Safari](https://www.apple.com/ca/safari/)
27+
28+
29+
## 🚀 Features
30+
31+
* **Drag & Drop** support for instant media viewing
32+
* **Stereo toggle** switch between monoscopic and stereo images (mono/top-bottom/side-by-side)
33+
* **Zooming** via mouse wheel or pinch gesture
34+
* **Interactive panning** with mouse or touch
35+
* **Fullscreen** mode via the bottom right button.
36+
* **Screenshot** functionality (UI hidden in capture)
37+
* **Video controls**: play/pause, timeline slider
38+
39+
40+
## 📦 Getting Started
41+
42+
**Option 1 – Local Use**
43+
44+
1. Download or clone this repository.
45+
2. Open `viewer360.html` in your browser.
46+
3. Drag and drop a supported 360° image or video file, or click "Select Media" to browse.
47+
48+
**Option 2 – Web Demo**
49+
50+
1. Visit the [live demo](http://progamergov.github.io/html-360-viewer) in your browser.
51+
2. Upload a 360° image or video to start viewing.
52+
53+
**Option 3 – Local Copy**
54+
55+
1. Copy the full contents of `viewer360.html` into a new text file.
56+
2. Rename the file to something like `viewer360.html` (make sure it ends in `.html`).
57+
3. Open it in your browser.
58+
59+
60+
## 🕹️ Controls
61+
62+
| Action | How to Use |
63+
| ------------------ | ------------------------------------ |
64+
| Pan View | Left-click + drag or touch + drag |
65+
| Zoom | Mouse wheel or pinch gesture |
66+
| Fullscreen | Use the browser's fullscreen control |
67+
| Stereo Toggle | Bottom-left “Stereo” button |
68+
| Screenshot | Camera icon at bottom center |
69+
| Upload/Reset Media | “Upload” button below controls |
70+
| Play/Pause Video | Play/pause button on video controls |
71+
| Seek in Video | Use the timeline slider |
72+
73+
74+
## 🤝 Contributing
75+
76+
Contributions are welcome! Please feel free to submit a Pull Request.
77+
78+
79+
## 🔬 Citation
80+
81+
If you use this library in your research or project, please refer to the included [CITATION.cff](CITATION.cff) file or cite it as follows:
82+
83+
### BibTeX
84+
```bibtex
85+
@misc{egan2025browser360html,
86+
title={Browser-Based Viewer for 360 Images and Videos},
87+
author={Egan, Ben},
88+
year={2025},
89+
publisher={GitHub},
90+
howpublished={\url{https://github.com/ProGamerGov/html-360-viewer}}
91+
}
92+
```
93+
94+
### APA Style
95+
```
96+
Egan, B. (2025). Browser-Based Viewer for 360 Images and Videos [Computer software]. GitHub. https://github.com/ProGamerGov/html-360-viewer
97+
```

examples/example_image.png

1.49 MB
Loading

0 commit comments

Comments
 (0)