Skip to content

Commit

Permalink
Build 522
Browse files Browse the repository at this point in the history
  • Loading branch information
simul-build committed Oct 25, 2024
1 parent e495373 commit 9785ddc
Show file tree
Hide file tree
Showing 271 changed files with 32,376 additions and 50 deletions.
2 changes: 1 addition & 1 deletion .buildinfo
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: f7bb84ec0ddc76a03ee1a3268fffb4d1
config: bdbb409b6eae191f654c29ea0f8a263a
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file added .doctrees/AndroidClient/index.doctree
Binary file not shown.
Binary file added .doctrees/docs/changelist.doctree
Binary file not shown.
Binary file added .doctrees/docs/client/index.doctree
Binary file not shown.
Binary file added .doctrees/docs/introduction.doctree
Binary file not shown.
Binary file added .doctrees/docs/nodejs/index.doctree
Binary file not shown.
Binary file added .doctrees/docs/protocol.doctree
Binary file not shown.
Binary file added .doctrees/docs/protocol/data_transfer.doctree
Binary file not shown.
Binary file added .doctrees/docs/protocol/service.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added .doctrees/docs/protocol/signaling.doctree
Binary file not shown.
Binary file added .doctrees/docs/protocol/video.doctree
Binary file not shown.
Binary file added .doctrees/docs/protocol/video_metadata.doctree
Binary file not shown.
Binary file added .doctrees/docs/reference/clientrenderer.doctree
Binary file not shown.
Binary file added .doctrees/docs/reference/index.doctree
Binary file not shown.
Binary file added .doctrees/docs/reference/libavstream.doctree
Binary file not shown.
Binary file not shown.
Binary file added .doctrees/docs/reference/server.doctree
Binary file not shown.
Binary file added .doctrees/docs/reference/teleportclient.doctree
Binary file not shown.
Binary file added .doctrees/docs/reference/teleportcore.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added .doctrees/docs/unity/index.doctree
Binary file not shown.
Binary file added .doctrees/docs/unreal/index.doctree
Binary file not shown.
Binary file modified .doctrees/environment.pickle
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added .doctrees/firstparty/Platform/Docs/index.doctree
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified .doctrees/index.doctree
Binary file not shown.
Binary file added .doctrees/pc_client/index.doctree
Binary file not shown.
126 changes: 126 additions & 0 deletions AndroidClient/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,126 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.19: https://docutils.sourceforge.io/" />

<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>2. Android Client &mdash; Teleport XR documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/graphviz.css" type="text/css" />
<!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->

<script src="../_static/jquery.js"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/sphinx_highlight.js"></script>
<script src="https://unpkg.com/[email protected]/dist/mermaid.min.js"></script>
<script>mermaid.initialize({startOnLoad:true});</script>
<script src="../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<link rel="next" title="2. Teleport Unity SDK" href="../docs/unity/index.html" />
<link rel="prev" title="1. Windows PC Client" href="../pc_client/index.html" />
</head>

<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >



<a href="../index.html" class="" >

<span class="sidebartitle">
Teleport XR
</span>

</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
<label class="search-label" for="q">Search the teleport documentation</label>
<input type="text" name="q" id="q" placeholder="Search..." aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<p class="caption" role="heading"><span class="caption-text">Contents</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../docs/introduction.html">1. Introduction</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../docs/client/index.html">Client</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../pc_client/index.html">1. Windows PC Client</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">2. Android Client</a></li>
<li class="toctree-l2"><a class="reference internal" href="../docs/client/index.html#teleport-url-s">Teleport URL’s</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="../docs/unity/index.html">2. Teleport Unity SDK</a></li>
<li class="toctree-l1"><a class="reference internal" href="../docs/unreal/index.html">3. Teleport Unreal SDK</a></li>
<li class="toctree-l1"><a class="reference internal" href="../docs/nodejs/index.html">4. Teleport NodeJS SDK</a></li>
<li class="toctree-l1"><a class="reference internal" href="../docs/protocol.html">5. The Teleport VR Protocol</a></li>
<li class="toctree-l1"><a class="reference internal" href="../docs/reference/index.html">6. Reference Implementation</a></li>
</ul>

</div>
</div>
</nav>

<div data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<h2 class="wy-nav-top">Navigation</h2><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="../index.html">Teleport XR</a>
</nav>

<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item"><a href="../docs/client/index.html">Client</a></li>
<li class="breadcrumb-item active"><span class="section-number">2. </span>Android Client</li>
<li class="wy-breadcrumbs-aside">
<a href="../_sources/AndroidClient/index.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">

<section id="android-client">
<h1><span class="section-number">2. </span>Android Client<a class="headerlink" href="#android-client" title="Permalink to this heading"></a></h1>
<p>The Android client is designed for use with headsets that use Android-based operating systems such as Meta Quest.</p>
</section>


</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="../pc_client/index.html" class="btn btn-neutral float-left" title="1. Windows PC Client" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
<a href="../docs/unity/index.html" class="btn btn-neutral float-right" title="2. Teleport Unity SDK" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>

<hr/>

<div role="contentinfo">
<p>&#169; Copyright 2018-2024, Teleport XR Ltd.</p>
</div>

</footer>
</div>
</div>
</div>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>

</body>
</html>
Binary file added _images/3d_viewer_screenshot.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 4 additions & 0 deletions _sources/AndroidClient/index.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Android Client
==============

The Android client is designed for use with headsets that use Android-based operating systems such as Meta Quest.
102 changes: 102 additions & 0 deletions _sources/docs/changelist.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
Changelist
=========
| **Fri 25 Oct** : :samp:`Merge branch 'main' of github.com:simul/Teleport`
| **Tue 22 Oct** : :samp:`Merge branch 'main' of github.com:simul/Teleport into main`
| **Tue 22 Oct** : :samp:`Merge branch 'main' of github.com:simul/Teleport`
| **Mon 21 Oct** : :samp:`Update gitmodules.`
| **Mon 21 Oct** : :samp:`Merge branch 'main' of github.com:simul/Teleport into main`
| **Mon 21 Oct** : :samp:`Added teleport-unreal submodule.`
| **Mon 21 Oct** : :samp:`Merge branch 'main' of github.com:simul/Teleport into main`
| **Thu 17 Oct** : :samp:`Further rearrangement of export headers.`
| **Tue 15 Oct** : :samp:`Fix docs build.`
| **Tue 15 Oct** : :samp:`Improve layout of exported headers.`
| **Tue 15 Oct** : :samp:`export_include folders: here we will put headers that use only plain-old-data (PoD) structures and C-style function calls, which can be used by external dll's.`
| **Tue 15 Oct** : :samp:`New docs structure, with root at the repo root.`
| **Thu 10 Oct** : :samp:`Fix missing headers from export_include.`
| **Mon 07 Oct** : :samp:`Fix client compilation for new header structure.`
| **Mon 07 Oct** : :samp:`export_include folders for dll-exported definitions.`
| **Mon 23 Sep** : :samp:`BC6 Texture transmission.`
| **Fri 20 Sep** : :samp:`Texture creation fixes for ktx2 format.`
| **Thu 12 Sep** : :samp:`Shallow fetch in FetchContent.`
| **Mon 09 Sep** : :samp:`Added AMD Compressonator. Incorporated direct headers and prebuilt libs due to the complex setup and build dependencies of this library. Android version will need to be built.`
| **Mon 09 Sep** : :samp:`ktx support for BC6H float16 textures.`
| **Mon 26 Aug** : :samp:`Added movement updates to UE plugin.`
| **Mon 26 Aug** : :samp:`Platform ptr.`
| **Fri 23 Aug** : :samp:`Added DoxyfileUnreal.in`
| **Fri 23 Aug** : :samp:`Merge branch 'main' of github.com:simul/Teleport`
| **Fri 23 Aug** : :samp:`Remove srt.`
| **Fri 23 Aug** : :samp:`Added Unreal and Node pages.`
| **Tue 13 Aug** : :samp:`Update release.yml`
| **Tue 13 Aug** : :samp:`Merge branch 'main' of github.com:simul/Teleport`
| **Tue 13 Aug** : :samp:`Removed plugins/UnrealDemo`
| **Tue 13 Aug** : :samp:`Created release.yml.`
| **Tue 13 Aug** : :samp:`Update release.yml`
| **Tue 13 Aug** : :samp:`Update release.yml`
| **Tue 13 Aug** : :samp:`Update release.yml`
| **Tue 13 Aug** : :samp:`Update release.yml`
| **Tue 13 Aug** : :samp:`Update build_pc_client.yml`
| **Tue 13 Aug** : :samp:`Update release.yml`
| **Tue 13 Aug** : :samp:`Update release.yml`
| **Tue 13 Aug** : :samp:`Update build_pc_client.yml`
| **Tue 13 Aug** : :samp:`Update release.yml`
| **Tue 13 Aug** : :samp:`Update build_pc_client.yml`
| **Tue 13 Aug** : :samp:`Update build_pc_client.yml`
| **Tue 13 Aug** : :samp:`Update release.yml`
| **Tue 13 Aug** : :samp:`Update release.yml`
| **Tue 13 Aug** : :samp:`Update release.yml`
| **Tue 13 Aug** : :samp:`Update release.yml`
| **Mon 12 Aug** : :samp:`Update build_pc_client.yml`
| **Mon 12 Aug** : :samp:`Update build_pc_client.yml`
| **Mon 12 Aug** : :samp:`Update release.yml`
| **Mon 12 Aug** : :samp:`Update release.yml`
| **Mon 12 Aug** : :samp:`Update build_pc_client.yml`
| **Mon 12 Aug** : :samp:`Update release.yml`
| **Mon 12 Aug** : :samp:`Update build_pc_client.yml`
| **Mon 12 Aug** : :samp:`Update release.yml`
| **Mon 12 Aug** : :samp:`Update release.yml`
| **Mon 12 Aug** : :samp:`Create release.yml`
| **Mon 12 Aug** : :samp:`Create installer in build`
| **Mon 12 Aug** : :samp:`Update build_pc_client.yml`
| **Mon 12 Aug** : :samp:`Installer licence file.`
| **Mon 12 Aug** : :samp:`Merge branch 'main' of github.com:simul/Teleport`
| **Mon 12 Aug** : :samp:`Installer adjustments.`
| **Sun 11 Aug** : :samp:`Update build_pc_client.yml`
| **Sun 11 Aug** : :samp:`Update build_pc_client.yml`
| **Sun 11 Aug** : :samp:`Update build_pc_client.yml`
| **Sun 11 Aug** : :samp:`Update build_pc_client.yml`
| **Sun 11 Aug** : :samp:`Update build_pc_client.yml`
| **Sat 10 Aug** : :samp:`Merge branch 'main' of github.com:simul/Teleport`
| **Sat 10 Aug** : :samp:`Sfx dependency in ClientRender/CMakeLists.txt`
| **Sat 10 Aug** : :samp:`Update build_pc_client.yml`
| **Sat 10 Aug** : :samp:`Platform Ptr.`
| **Fri 09 Aug** : :samp:`Update build_pc_client.yml`
| **Fri 09 Aug** : :samp:`Update build_pc_client.yml`
| **Fri 09 Aug** : :samp:`Merge branch 'main' of github.com:simul/Teleport`
| **Fri 09 Aug** : :samp:`.`
| **Fri 09 Aug** : :samp:`Update build_pc_client.yml`
| **Fri 09 Aug** : :samp:`Update build_pc_client.yml`
| **Fri 09 Aug** : :samp:`.`
| **Fri 09 Aug** : :samp:`Ptr`
| **Fri 09 Aug** : :samp:`Ptr`
| **Fri 09 Aug** : :samp:`Change options in Sfx for ClientRender/CMakeLists.txt`
| **Fri 09 Aug** : :samp:`Platform ptr.`
| **Fri 09 Aug** : :samp:`Ptr`
| **Fri 09 Aug** : :samp:`Remove plugins folder and UnrealDemo submodule.`
| **Thu 08 Aug** : :samp:`Ptr`
| **Thu 08 Aug** : :samp:`Ptr.`
| **Thu 08 Aug** : :samp:`Platform ptr`
| **Thu 08 Aug** : :samp:`Merge branch 'main' of github.com:simul/Teleport`
| **Thu 08 Aug** : :samp:`Platform ptr.`
| **Thu 08 Aug** : :samp:`Update build_pc_client.yml`
| **Thu 08 Aug** : :samp:`Update build_pc_client.yml`
| **Thu 08 Aug** : :samp:`Merge branch 'main' of github.com:simul/Teleport`
| **Thu 08 Aug** : :samp:`Ptr`
| **Thu 08 Aug** : :samp:`Update build_pc_client.yml`
| **Thu 08 Aug** : :samp:`Update build_pc_client.yml`
| **Thu 08 Aug** : :samp:`Merge branch 'main' of github.com:simul/Teleport`
| **Thu 08 Aug** : :samp:`Force ASSIMP off for Platform. Allow compilation without CUDA.`
| **Thu 08 Aug** : :samp:`Update build_pc_client.yml`
| **Thu 08 Aug** : :samp:`Update build_pc_client.yml`
| **Thu 08 Aug** : :samp:`Update build_pc_client.yml`
| **Thu 08 Aug** : :samp:`Update build_pc_client.yml`
| **Thu 08 Aug** : :samp:`Update build_pc_client.yml`
68 changes: 68 additions & 0 deletions _sources/docs/client/index.rst.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
Client
######

.. toctree::
:maxdepth: 1
:numbered:

../../pc_client/index
../../AndroidClient/index

The "Reference" Teleport Client application is available for Windows PC (with optional XR support),
and Meta Quest headsets. It's available from https://teleportvr.io/downloads.

On launching the client, you will be presented with an address bar. In desktop mode, this will appear
at the top of the window, just as in a web browser.

.. figure:: DesktopClient.png
:width: 600
:alt: The desktop PC Client is shown, with an address bar and connect button at the top.

The desktop PC Client has an address bar and connect button at the top.

In XR mode, it will float in front of you, atop a
virtual keyboard for typing. You can connect to any Teleport server by entering its address here and clicking
the connect button.

.. figure:: VRClient.png
:width: 600
:alt: The XR Client is shown, with an address bar and virtual keyboard in front of the viewer.

The desktop PC Client has a virtual keyboard, with an address bar and connect button.

In XR mode, the address bar disappears when the connection is accepted. You can recall the address bar
by clicking the default "Menu" button for your XR device.

Most XR devices have one or two buttons that are reserved for special functions, like the Menu button or the "Meta" button on the Quest controller.
All other inputs, including headset and handset motion and other trackers, are mapped according to the Teleport
server's particular setup. Their functions will change, depending on the app you're connected to.

This is distinct from many other online XR systems. Two different Teleport servers are not two distinct
"levels", "worlds" or "locations" for a single application. They are two different apps.

Teleport URL's
--------------
A teleport URL is of the form:

``[PROTOCOL]://[DOMAIN:PORT]/[PATH]/[PARAMETERS]``

This is similar to an HTTP request, except that a Teleport URL doesn't refer to a "document" or "resource". Instead, it's a request for a real-time connection.
The [PROTOCOL] would be 'teleport'. [DOMAIN:PORT] would be a domain name of either two or three parts, or an IP address, optionally followed by a colon and a port number. The interpretation of the path and parameters are up to the server, but in general, the path should describe a location within the server's application, while the parameters should represent any other information the URL encodes.

Specifically, a Teleport URL would look like this:

``teleport://subdomain.domain.tld:port/path/?parameter=value``

For example:

`teleport://home.teleportvr.io <teleport://home.teleportvr.io>`_

`mmv://L_CyberpunkCity/10,10,10 <mmv://L_CyberpunkCity/10,10,10>`_

`mmv://L_BurningMan/10,10,10 <mmv://L_BurningMan/10,10,10>`_

`mmv://L_Himalayas/10,10,10 <mmv://L_Himalayas/10,10,10>`_

`mmv://L_MetaArcade/10,10,10 <mmv://L_MetaArcade/10,10,10>`_

`mmv://L_Toronto/10,10,10 <mmv://L_Toronto/10,10,10>`_
Loading

0 comments on commit 9785ddc

Please sign in to comment.