# Welcome to MARTINS.js!

<iframe src="https://ghbtns.com/github-btn.html?user=alemart&repo=martins-js&type=star&count=true&size=large" frameborder="0" scrolling="0" width="170" height="30" title="GitHub"></iframe> <iframe src="https://ghbtns.com/github-btn.html?user=alemart&repo=martins-js&type=watch&count=true&size=large&v=2" frameborder="0" scrolling="0" width="170" height="30" title="GitHub"></iframe>

**MARTINS.js** is a GPU-accelerated Augmented Reality engine for the web. It's a standalone WebAR technology for creating AR experiences that run in web browsers. Users don't need specialized hardware nor dedicated software - only a modern and compatible web browser.

[Learn WebAR](./introduction.md){ .md-button .md-button--primary } [Try a demo](../demo/instructions.md){ .md-button } [:heart:{ .heart } Support my work](../support-my-work.md){ .md-button }

:man_technologist: MARTINS.js is developed by [Alexandre Martins](https://github.com/alemart) and is based on [Speedy Vision](https://github.com/alemart/speedy-vision).

:books: Full documentation is available at <https://alemart.github.io/martins-js/>.

:mailbox: [Contact me](https://github.com/alemart) for freelance work if you're not a developer.

## What can you do with Web-based Augmented Reality?

Lots of exciting things that run in the web browser!

* Marketing gimmicks
* WebAR Games
* Interactive art
* Tech demos
* ...and more!

[Try a demo!](../demo/instructions.md)

## Why use MARTINS.js?

Here is why MARTINS.js is a great choice for creating Augmented Reality experiences:

* **No need to download apps!** MARTINS.js is a WebAR engine. It runs in web browsers. Users can access the AR experience immediately.
* **Fast and powerful!** MARTINS.js is GPU-accelerated. It uses WebGL2 and WebAssembly for turbocharged performance.
* **No need of custom hardware or software!** MARTINS.js is built from scratch using standard web technologies. All it requires is a modern and compatible web browser.
* **Fully standalone!** MARTINS.js has in it everything it needs to analyze the environment and help you create AR. There are no additional requirements. No need of WebXR.
* **Easy to get started!** MARTINS.js can be used with a `<script>` tag in your page. A static HTML page is enough to get started.

## Features

Currently supported features:

* **Image tracking**, also known as natural feature tracking. Use it to track detailed images such as: book covers, cartoons and photos.

## Browser compatibility

MARTINS.js is currently compatible with the latest versions of almost all major web browsers:

| Chrome | Edge | Firefox | Opera | Safari |
|:------:|:----:|:-------:|:-----:|:------:|
| :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | :heavy_check_mark: | - |

Safari support: coming soon.

MARTINS.js requires WebGL2 and WebAssembly. No need of WebXR.

## License

Released under the [AGPL 3.0](../license/agpl-3.0.md). A different license is available if you [support my work](../support-my-work.md).