Skip to content

Instantly share code, notes, and snippets.

@martindevans
Last active September 5, 2022 02:25
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save martindevans/18c00459abe8393279ba5fdba3a362c9 to your computer and use it in GitHub Desktop.
Save martindevans/18c00459abe8393279ba5fdba3a362c9 to your computer and use it in GitHub Desktop.
$ curl -v https://placeholder-software.co.uk/dissonance/docs/Basics/Getting-Started/
* Trying 2606:4700:3035::ac43:d9e6:443...
* TCP_NODELAY set
* Connected to placeholder-software.co.uk (2606:4700:3035::ac43:d9e6) port 443 (#0)
* ALPN, offering h2
* ALPN, offering http/1.1
* successfully set certificate verify locations:
* CAfile: /etc/ssl/certs/ca-certificates.crt
CApath: /etc/ssl/certs
* TLSv1.3 (OUT), TLS handshake, Client hello (1):
* TLSv1.3 (IN), TLS handshake, Server hello (2):
* TLSv1.3 (IN), TLS handshake, Encrypted Extensions (8):
* TLSv1.3 (IN), TLS handshake, Certificate (11):
* TLSv1.3 (IN), TLS handshake, CERT verify (15):
* TLSv1.3 (IN), TLS handshake, Finished (20):
* TLSv1.3 (OUT), TLS change cipher, Change cipher spec (1):
* TLSv1.3 (OUT), TLS handshake, Finished (20):
* SSL connection using TLSv1.3 / TLS_AES_256_GCM_SHA384
* ALPN, server accepted to use h2
* Server certificate:
* subject: C=US; ST=California; L=San Francisco; O=Cloudflare, Inc.; CN=sni.cloudflaressl.com
* start date: May 25 00:00:00 2022 GMT
* expire date: May 25 23:59:59 2023 GMT
* subjectAltName: host "placeholder-software.co.uk" matched cert's "placeholder-software.co.uk"
* issuer: C=US; O=Cloudflare, Inc.; CN=Cloudflare Inc ECC CA-3
* SSL certificate verify ok.
* Using HTTP2, server supports multi-use
* Connection state changed (HTTP/2 confirmed)
* Copying HTTP/2 data in stream buffer to connection buffer after upgrade: len=0
* Using Stream ID: 1 (easy handle 0x555c7bc7e2f0)
> GET /dissonance/docs/Basics/Getting-Started/ HTTP/2
> Host: placeholder-software.co.uk
> user-agent: curl/7.68.0
> accept: */*
>
* TLSv1.3 (IN), TLS handshake, Newsession Ticket (4):
* TLSv1.3 (IN), TLS handshake, Newsession Ticket (4):
* old SSL session ID is stale, removing
* Connection state changed (MAX_CONCURRENT_STREAMS == 256)!
< HTTP/2 200
< date: Mon, 05 Sep 2022 02:21:06 GMT
< content-type: text/html; charset=utf-8
< access-control-allow-origin: *
< age: 0
< cache-control: max-age=600
< expires: Mon, 05 Sep 2022 01:39:19 GMT
< last-modified: Tue, 23 Aug 2022 21:57:40 GMT
< permissions-policy: interest-cohort=()
< vary: Accept-Encoding
< via: 1.1 varnish
< x-cache: HIT
< x-cache-hits: 1
< x-fastly-request-id: b59b5662af1ed2f0ca90b271c8ebdc52fe0dae05
< x-github-request-id: 94B8:2B19:9F414B:A7AE06:631550EF
< x-proxy-cache: MISS
< x-served-by: cache-lcy19221-LCY
< x-timer: S1662344466.208754,VS0,VE111
< cf-cache-status: DYNAMIC
< report-to: {"endpoints":[{"url":"https:\/\/a.nel.cloudflare.com\/report\/v3?s=%2BBmAOoN7DCmupE0OHcdxV3tRj8aU%2BiHY4J2Xn4QEUoigXpwrcaAmehuWgjHVTowgl1fz2faIHOSG%2F0wX%2F0H1mAycFVLX7uIwCdx6%2Bdqxd5%2BYYSeHueRuMOPetZoQNnFxf0JWwxcHXscTif63P6P1S%2BKBPod4Xs1sOw%3D%3D"}],"group":"cf-nel","max_age":604800}
< nel: {"success_fraction":0,"report_to":"cf-nel","max_age":604800}
< server: cloudflare
< cf-ray: 745b7d51aab473ff-LHR
< alt-svc: h3=":443"; ma=86400, h3-29=":443"; ma=86400
<
<!doctype html>
<html lang="en" class="no-js">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link rel="canonical" href="https://placeholder-software.co.uk/dissonance/docs/Basics/Getting-Started.html">
<link rel="icon" href="../dissonance.png">
<meta name="generator" content="mkdocs-1.3.1, mkdocs-material-8.4.1">
<title>Getting Started - Dissonance Voice Chat</title>
<link rel="stylesheet" href="../assets/stylesheets/main.69437709.min.css">
<link rel="stylesheet" href="../assets/stylesheets/palette.cbb835fc.min.css">
<meta name="theme-color" content="#02a6f2">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
<style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
<link rel="stylesheet" href="../css/pygment_tweaks.css">
<link rel="stylesheet" href="../css/header_tweaks.css">
<script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
</head>
<body dir="ltr" data-md-color-scheme="slate" data-md-color-primary="light-blue" data-md-color-accent="">
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip">
<a href="#1-import-dissonance" class="md-skip">
Skip to content
</a>
</div>
<div data-md-component="announce">
</div>
<header class="md-header" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href="../index.html" title="Dissonance Voice Chat" class="md-header__button md-logo" aria-label="Dissonance Voice Chat" data-md-component="logo">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z" /></svg>
</a>
<label class="md-header__button md-icon" for="__drawer">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z" /></svg>
</label>
<div class="md-header__title" data-md-component="header-title">
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
Dissonance Voice Chat
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
Getting Started
</span>
</div>
</div>
</div>
<label class="md-header__button md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z" /></svg>
</label>
<div class="md-search" data-md-component="search" role="dialog">
<label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search">
<form class="md-search__form" name="search">
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
<label class="md-search__icon md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z" /></svg>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z" /></svg>
</label>
<nav class="md-search__options" aria-label="Search">
<button type="reset" class="md-search__icon md-icon" aria-label="Clear" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41Z" /></svg>
</button>
</nav>
</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" data-md-scrollfix>
<div class="md-search-result" data-md-component="search-result">
<div class="md-search-result__meta">
Initializing search
</div>
<ol class="md-search-result__list"></ol>
</div>
</div>
</div>
</div>
</div>
<div class="md-header__source">
<a href="https://github.com/Placeholder-Software/Dissonance" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 496 512"><path d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6zm-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3zm44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9zM244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8zM97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1zm-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7zm32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1zm-11.4-14.7c-1.6 1-1.6 3.6 0 5.9 1.6 2.3 4.3 3.3 5.6 2.3 1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2z" /></svg>
</div>
<div class="md-source__repository">
Issue Tracker
</div>
</a>
</div>
</nav>
</header>
<div class="md-container" data-md-component="container">
<main class="md-main" data-md-component="main">
<div class="md-main__inner md-grid">
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation">
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--primary md-nav--integrated" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href="../index.html" title="Dissonance Voice Chat" class="md-nav__button md-logo" aria-label="Dissonance Voice Chat" data-md-component="logo">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z" /></svg>
</a>
Dissonance Voice Chat
</label>
<div class="md-nav__source">
<a href="https://github.com/Placeholder-Software/Dissonance" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 496 512"><path d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6zm-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3zm44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9zM244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8zM97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1zm-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7zm32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1zm-11.4-14.7c-1.6 1-1.6 3.6 0 5.9 1.6 2.3 4.3 3.3 5.6 2.3 1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2z" /></svg>
</div>
<div class="md-source__repository">
Issue Tracker
</div>
</a>
</div>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../index.html" class="md-nav__link">
Home
</a>
</li>
<li class="md-nav__item md-nav__item--active md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2" type="checkbox" id="__nav_2" checked>
<label class="md-nav__link" for="__nav_2">
Project Setup
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" aria-label="Project Setup" data-md-level="1">
<label class="md-nav__title" for="__nav_2">
<span class="md-nav__icon md-icon"></span>
Project Setup
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item md-nav__item--active">
<input class="md-nav__toggle md-toggle" data-md-toggle="toc" type="checkbox" id="__toc">
<label class="md-nav__link md-nav__link--active" for="__toc">
Getting Started
<span class="md-nav__icon md-icon"></span>
</label>
<a href="Getting-Started.html" class="md-nav__link md-nav__link--active">
Getting Started
</a>
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#1-import-dissonance" class="md-nav__link">
1. Import Dissonance
</a>
</li>
<li class="md-nav__item">
<a href="#2-download-integrations" class="md-nav__link">
2. Download Integrations
</a>
</li>
<li class="md-nav__item">
<a href="#3-run-in-background" class="md-nav__link">
3. Run In Background
</a>
</li>
<li class="md-nav__item">
<a href="#4-per-platform-specific-setup" class="md-nav__link">
4. Per Platform Specific Setup
</a>
</li>
<li class="md-nav__item">
<a href="#4-complete" class="md-nav__link">
4. Complete!
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="Choosing-A-Network.html" class="md-nav__link">
Choosing A Network
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_2_3" type="checkbox" id="__nav_2_3">
<label class="md-nav__link" for="__nav_2_3">
Installation Requirements
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" aria-label="Installation Requirements" data-md-level="2">
<label class="md-nav__title" for="__nav_2_3">
<span class="md-nav__icon md-icon"></span>
Installation Requirements
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="Licensing.html" class="md-nav__link">
Licensing
</a>
</li>
<li class="md-nav__item">
<a href="../Platforms/Windows%20Desktop.html" class="md-nav__link">
Windows (Desktop)
</a>
</li>
<li class="md-nav__item">
<a href="../Platforms/Windows%20UWP%20%26%20Hololens.html" class="md-nav__link">
Windows (UWP/Hololens)
</a>
</li>
<li class="md-nav__item">
<a href="../Platforms/Linux.html" class="md-nav__link">
Linux
</a>
</li>
<li class="md-nav__item">
<a href="../Platforms/MacOS.html" class="md-nav__link">
MacOS
</a>
</li>
<li class="md-nav__item">
<a href="../Platforms/Android.html" class="md-nav__link">
Android (Including Oculus Quest)
</a>
</li>
<li class="md-nav__item">
<a href="../Platforms/iOS.html" class="md-nav__link">
iOS
</a>
</li>
<li class="md-nav__item">
<a href="../Platforms/Magic%20Leap.html" class="md-nav__link">
Magic Leap
</a>
</li>
<li class="md-nav__item">
<a href="../Platforms/Oculus%20OVR.html" class="md-nav__link">
Oculus OVR
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="Other-Integrations.html" class="md-nav__link">
Other Integrations
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_3" type="checkbox" id="__nav_3">
<label class="md-nav__link" for="__nav_3">
Quick Start Guides
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" aria-label="Quick Start Guides" data-md-level="1">
<label class="md-nav__title" for="__nav_3">
<span class="md-nav__icon md-icon"></span>
Quick Start Guides
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="Quick-Start-Mirror.html" class="md-nav__link">
Mirror Networking
</a>
</li>
<li class="md-nav__item">
<a href="Quick-Start-Unity-NFGO.html" class="md-nav__link">
Unity Netcode For GameObjects
</a>
</li>
<li class="md-nav__item">
<a href="Quick-Start-Forge-Remastered.html" class="md-nav__link">
Forge Networking Remastered
</a>
</li>
<li class="md-nav__item">
<a href="Quick-Start-DR2.html" class="md-nav__link">
Dark Rift 2
</a>
</li>
<li class="md-nav__item">
<a href="Quick-Start-Photon.html" class="md-nav__link">
Photon Unity Networking
</a>
</li>
<li class="md-nav__item">
<a href="Quick-Start-Photon-Bolt.html" class="md-nav__link">
Photon BOLT
</a>
</li>
<li class="md-nav__item">
<a href="Quick-Start-TNet3.html" class="md-nav__link">
TNet3
</a>
</li>
<li class="md-nav__item">
<a href="Quick-Start-UNet-HLAPI.html" class="md-nav__link">
Unity Networking HLAPI
</a>
</li>
<li class="md-nav__item">
<a href="Quick-Start-Steamworks.Net-P2P.html" class="md-nav__link">
Steamworks.NET P2P
</a>
</li>
<li class="md-nav__item">
<a href="Quick-Start-PureP2P.html" class="md-nav__link">
WebRTC Network (self contained)
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="Introduction-To-Chat-Rooms.html" class="md-nav__link">
Basic Concepts
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_5" type="checkbox" id="__nav_5">
<label class="md-nav__link" for="__nav_5">
Introductory Tutorials
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" aria-label="Introductory Tutorials" data-md-level="1">
<label class="md-nav__title" for="__nav_5">
<span class="md-nav__icon md-icon"></span>
Introductory Tutorials
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../Tutorials/Push-to-Talk.html" class="md-nav__link">
Push-To-Talk
</a>
</li>
<li class="md-nav__item">
<a href="../Tutorials/Global-Chat-Room.html" class="md-nav__link">
Global Chat Room
</a>
</li>
<li class="md-nav__item">
<a href="../Tutorials/Team-Chat-Rooms.html" class="md-nav__link">
Team Chat Rooms
</a>
</li>
<li class="md-nav__item">
<a href="../Tutorials/Text-Chat.html" class="md-nav__link">
Text Chat
</a>
</li>
<li class="md-nav__item">
<a href="../Tutorials/Direct-Player-Transmit.html" class="md-nav__link">
Transmit to Player
</a>
</li>
<li class="md-nav__item">
<a href="../Tutorials/Position-Tracking.html" class="md-nav__link">
Position Tracking
</a>
</li>
<li class="md-nav__item">
<a href="../Tutorials/Position-Tracking-For-Bolt.html" class="md-nav__link">
Position Tracking For BOLT
</a>
</li>
<li class="md-nav__item">
<a href="../Tutorials/Proximity-Chat.html" class="md-nav__link">
Proximity Chat
</a>
</li>
<li class="md-nav__item">
<a href="../Tutorials/Collider-Chat-Room.html" class="md-nav__link">
Collider Chat Rooms
</a>
</li>
<li class="md-nav__item">
<a href="../Tutorials/Player-State.html" class="md-nav__link">
Finding Players
</a>
</li>
<li class="md-nav__item">
<a href="../Tutorials/Audio-Mixing.html" class="md-nav__link">
Audio Mixing For Voice
</a>
</li>
<li class="md-nav__item">
<a href="../Tutorials/Access-Control-Tokens.html" class="md-nav__link">
Access Tokens
</a>
</li>
<li class="md-nav__item">
<a href="../Tutorials/Channel-Priority.html" class="md-nav__link">
Channel Priority
</a>
</li>
<li class="md-nav__item">
<a href="../Tutorials/Channel-Volume.html" class="md-nav__link">
Channel Volume
</a>
</li>
<li class="md-nav__item">
<a href="../Tutorials/Playback-Prefab.html" class="md-nav__link">
Custom AudioSource Settings
</a>
</li>
<li class="md-nav__item">
<a href="../Tutorials/Script-Controlled-Speech.html" class="md-nav__link">
Script Controlled Speech
</a>
</li>
<li class="md-nav__item">
<a href="../Tutorials/Spatializer-Plugin.html" class="md-nav__link">
Spatialization Plugins
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_6" type="checkbox" id="__nav_6">
<label class="md-nav__link" for="__nav_6">
Advanced Tutorials
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" aria-label="Advanced Tutorials" data-md-level="1">
<label class="md-nav__title" for="__nav_6">
<span class="md-nav__icon md-icon"></span>
Advanced Tutorials
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../Tutorials/Custom-Networking.html" class="md-nav__link">
Writing A Custom Network Integration
</a>
</li>
<li class="md-nav__item">
<a href="../Tutorials/Custom-Position-Tracking.html" class="md-nav__link">
Writing A Custom IDissonancePlayer
</a>
</li>
<li class="md-nav__item">
<a href="../Tutorials/Custom-Microphone-Capture.html" class="md-nav__link">
Writing A Custom Microphone Capture System
</a>
</li>
<li class="md-nav__item">
<a href="../Tutorials/UsingIMicrophoneSubscriber.html" class="md-nav__link">
Direct Access To Recorded Audio
</a>
</li>
<li class="md-nav__item">
<a href="../Tutorials/Directly-Using-Channels.html" class="md-nav__link">
Using Channels
</a>
</li>
<li class="md-nav__item">
<a href="../Tutorials/Acoustic-Echo-Cancellation.html" class="md-nav__link">
Acoustic Echo Cancellation
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7" type="checkbox" id="__nav_7">
<label class="md-nav__link" for="__nav_7">
Reference
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" aria-label="Reference" data-md-level="1">
<label class="md-nav__title" for="__nav_7">
<span class="md-nav__icon md-icon"></span>
Reference
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7_1" type="checkbox" id="__nav_7_1">
<label class="md-nav__link" for="__nav_7_1">
Components
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" aria-label="Components" data-md-level="2">
<label class="md-nav__title" for="__nav_7_1">
<span class="md-nav__icon md-icon"></span>
Components
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../Reference/Components/Voice-Broadcast-Trigger.html" class="md-nav__link">
Voice Broadcast Trigger
</a>
</li>
<li class="md-nav__item">
<a href="../Reference/Components/Voice-Receipt-Trigger.html" class="md-nav__link">
Voice Receipt Trigger
</a>
</li>
<li class="md-nav__item">
<a href="../Reference/Components/Dissonance-Comms.html" class="md-nav__link">
Dissonance Comms
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7_2" type="checkbox" id="__nav_7_2">
<label class="md-nav__link" for="__nav_7_2">
Audio
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" aria-label="Audio" data-md-level="2">
<label class="md-nav__title" for="__nav_7_2">
<span class="md-nav__icon md-icon"></span>
Audio
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../Reference/Audio/VoiceSettings.html" class="md-nav__link">
Voice Settings
</a>
</li>
<li class="md-nav__item">
<a href="../Reference/Audio/IMicrophoneCapture.html" class="md-nav__link">
IMicrophoneCapture
</a>
</li>
<li class="md-nav__item">
<a href="../Reference/Audio/IMicrophoneSubscriber.html" class="md-nav__link">
IMicrophoneSubscriber
</a>
</li>
<li class="md-nav__item">
<a href="../Reference/Audio/BaseMicrophoneSubscriber.html" class="md-nav__link">
BaseMicrophoneSubscriber
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7_3" type="checkbox" id="__nav_7_3">
<label class="md-nav__link" for="__nav_7_3">
Networking
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" aria-label="Networking" data-md-level="2">
<label class="md-nav__title" for="__nav_7_3">
<span class="md-nav__icon md-icon"></span>
Networking
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../Reference/Networking/Network-Protocol.html" class="md-nav__link">
Network Protocol
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle" data-md-toggle="__nav_7_4" type="checkbox" id="__nav_7_4">
<label class="md-nav__link" for="__nav_7_4">
Other
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" aria-label="Other" data-md-level="2">
<label class="md-nav__title" for="__nav_7_4">
<span class="md-nav__icon md-icon"></span>
Other
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../Reference/Other/VoiceSettings.html" class="md-nav__link">
Voice Settings
</a>
</li>
<li class="md-nav__item">
<a href="../Reference/Other/Rooms.html" class="md-nav__link">
Rooms
</a>
</li>
<li class="md-nav__item">
<a href="../Reference/Other/RoomChannels.html" class="md-nav__link">
RoomChannels
</a>
</li>
<li class="md-nav__item">
<a href="../Reference/Other/RoomChannel.html" class="md-nav__link">
RoomChannel
</a>
</li>
<li class="md-nav__item">
<a href="../Reference/Other/PlayerChannels.html" class="md-nav__link">
PlayerChannels
</a>
</li>
<li class="md-nav__item">
<a href="../Reference/Other/PlayerChannel.html" class="md-nav__link">
PlayerChannel
</a>
</li>
<li class="md-nav__item">
<a href="../Reference/Other/TextChat.html" class="md-nav__link">
TextChat
</a>
</li>
<li class="md-nav__item">
<a href="../Reference/Other/VoicePlayerState.html" class="md-nav__link">
VoicePlayerState
</a>
</li>
<li class="md-nav__item">
<a href="../Reference/Other/RemoteChannel.html" class="md-nav__link">
RemoteChannel
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-content" data-md-component="content">
<article class="md-content__inner md-typeset">
<a href="https://github.com/Placeholder-Software/Dissonance/edit/master/docs/Basics/Getting-Started.md" title="Edit this page" class="md-content__button md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20.71 7.04c.39-.39.39-1.04 0-1.41l-2.34-2.34c-.37-.39-1.02-.39-1.41 0l-1.84 1.83 3.75 3.75M3 17.25V21h3.75L17.81 9.93l-3.75-3.75L3 17.25Z" /></svg>
</a>
<h1>Getting Started</h1>
<p>In this tutorial you will create a new project, import Dissonance and change some settings required for Dissonance to work properly.</p>
<h3 id="1-import-dissonance">1. Import Dissonance<a class="headerlink" href="#1-import-dissonance" title="Permanent link">⚓︎</a></h3>
<p>Import the Dissonance asset into the project. This will install two folders into your project: <code>Assets/Plugins/Dissonance</code> contains the main source code of Dissonance, <code>Assets/Dissonance</code> will contain any integration packages which you install.</p>
<h3 id="2-download-integrations">2. Download Integrations<a class="headerlink" href="#2-download-integrations" title="Permanent link">⚓︎</a></h3>
<p>When you import a new version of Dissonance a window will pop up with a list of available integrations, you can launch this window again by navigating to <code>Windows &gt; Dissonance &gt; Download Integrations</code>.</p>
<p>To use Dissonance you <strong>must</strong> install at a network backend integration - without this Dissonance cannot send anything over the network! Refer to <a href="Choosing-A-Network.html">these docs</a> for help on choosing which one to use. Each integration package includes a demo scene, you should run this demo scene once you have installed the package to verify that Dissonance is properly installed and working in your project.</p>
<p>You may also wish to use some of our other integrations. Refer to <a href="Other-Integrations">these docs</a> for a list of what's available.</p>
<h3 id="3-run-in-background">3. Run In Background<a class="headerlink" href="#3-run-in-background" title="Permanent link">⚓︎</a></h3>
<p>Multiplayer games need to keep running (and processing network packets) even when the game window does not have focus. To do this navigate to <code>Edit -&gt; Project Settings -&gt; Player</code> and enable <strong>Run In Background</strong>.</p>
<h3 id="4-per-platform-specific-setup">4. Per Platform Specific Setup<a class="headerlink" href="#4-per-platform-specific-setup" title="Permanent link">⚓︎</a></h3>
<p>Some platforms have special setup requirements, make sure to read the documentation for the platforms you want to work with:</p>
<ul>
<li><a href="../Platforms/Android.html">Android &amp; Oculus Go</a></li>
<li><a href="../Platforms/iOS.html">iOS</a></li>
<li><a href="../Platforms/Linux.html">Linux</a></li>
<li><a href="../Platforms/MacOS.html">MacOS</a></li>
<li><a href="../Platforms/Magic%20Leap.html">Magic Leap</a></li>
<li><a href="../Platforms/Windows%20Desktop.html">Windows (Desktop)</a></li>
<li><a href="../Platforms/Windows%20UWP%20%26%20Hololens.html">Windows (UWP/Hololens)</a></li>
<li><a href="../Platforms/Oculus%20OVR.html">Oculus OVR</a></li>
</ul>
<h2 id="4-complete">4. Complete!<a class="headerlink" href="#4-complete" title="Permanent link">⚓︎</a></h2>
<p>That's all you need to get a project set up and ready for Dissonance. Next, follow the appropriate Quick Start tutorial for the network system you plan to use:</p>
<ul>
<li><a href="Quick-Start-Mirror.html">Quick Start - Mirror</a></li>
<li><a href="Quick-Start-Forge-Remastered.html">Quick Start - Forge Remastered</a></li>
<li><a href="Quick-Start-Photon.html">Quick Start - Photon (PUN2)</a></li>
<li><a href="Quick-Start-Photon-Bolt.html">Quick Start - Photon Bolt</a></li>
<li><a href="Quick-Start-Unity-NFGO.html">Quick Start - Unity Netcode For GameObjects</a></li>
<li><a href="Quick-Start-UNet-HLAPI.html">Quick Start - Unity Networking HLAPI</a></li>
<li><a href="Quick-Start-DR2.html">Quick Start - Dark🗲Rift 2</a></li>
<li><a href="Quick-Start-PureP2P.html">Quick Start - WebRTC Network</a></li>
<li><a href="Quick-Start-Steamworks.Net-P2P.html">Quick Start - Steamworks.NET</a></li>
<li><a href="Quick-Start-TNet3.html">Quick Start - TNet3</a></li>
</ul>
</article>
</div>
</div>
</main>
<footer class="md-footer">
<nav class="md-footer__inner md-grid" aria-label="Footer">
<a href="../index.html" class="md-footer__link md-footer__link--prev" aria-label="Previous: Home" rel="prev">
<div class="md-footer__button md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z" /></svg>
</div>
<div class="md-footer__title">
<div class="md-ellipsis">
<span class="md-footer__direction">
Previous
</span>
Home
</div>
</div>
</a>
<a href="Choosing-A-Network.html" class="md-footer__link md-footer__link--next" aria-label="Next: Choosing A Network" rel="next">
<div class="md-footer__title">
<div class="md-ellipsis">
<span class="md-footer__direction">
Next
</span>
Choosing A Network
</div>
</div>
<div class="md-footer__button md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11H4Z" /></svg>
</div>
</a>
</nav>
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
<div class="md-copyright">
<div class="md-copyright__highlight">
<a href='https://placeholder-software.co.uk/dissonance/'>Placeholder Software</a>
</div>
Made with
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
Material for MkDocs
</a>
</div>
<div class="md-social">
<a href="https://twitter.com/placeholdersoft" target="_blank" rel="noopener" title="twitter.com" class="md-social__link">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><path d="M459.37 151.716c.325 4.548.325 9.097.325 13.645 0 138.72-105.583 298.558-298.558 298.558-59.452 0-114.68-17.219-161.137-47.106 8.447.974 16.568 1.299 25.34 1.299 49.055 0 94.213-16.568 130.274-44.832-46.132-.975-84.792-31.188-98.112-72.772 6.498.974 12.995 1.624 19.818 1.624 9.421 0 18.843-1.3 27.614-3.573-48.081-9.747-84.143-51.98-84.143-102.985v-1.299c13.969 7.797 30.214 12.67 47.431 13.319-28.264-18.843-46.781-51.005-46.781-87.391 0-19.492 5.197-37.36 14.294-52.954 51.655 63.675 129.3 105.258 216.365 109.807-1.624-7.797-2.599-15.918-2.599-24.04 0-57.828 46.782-104.934 104.934-104.934 30.213 0 57.502 12.67 76.67 33.137 23.715-4.548 46.456-13.32 66.599-25.34-7.798 24.366-24.366 44.833-46.132 57.827 21.117-2.273 41.584-8.122 60.426-16.243-14.292 20.791-32.161 39.308-52.628 54.253z" /></svg>
</a>
<a href="https://discord.gg/8dKpP5W" target="_blank" rel="noopener" title="discord.gg" class="md-social__link">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 640 512"><path d="M524.531 69.836a1.5 1.5 0 0 0-.764-.7A485.065 485.065 0 0 0 404.081 32.03a1.816 1.816 0 0 0-1.923.91 337.461 337.461 0 0 0-14.9 30.6 447.848 447.848 0 0 0-134.426 0 309.541 309.541 0 0 0-15.135-30.6 1.89 1.89 0 0 0-1.924-.91 483.689 483.689 0 0 0-119.688 37.107 1.712 1.712 0 0 0-.788.676C39.068 183.651 18.186 294.69 28.43 404.354a2.016 2.016 0 0 0 .765 1.375 487.666 487.666 0 0 0 146.825 74.189 1.9 1.9 0 0 0 2.063-.676A348.2 348.2 0 0 0 208.12 430.4a1.86 1.86 0 0 0-1.019-2.588 321.173 321.173 0 0 1-45.868-21.853 1.885 1.885 0 0 1-.185-3.126 251.047 251.047 0 0 0 9.109-7.137 1.819 1.819 0 0 1 1.9-.256c96.229 43.917 200.41 43.917 295.5 0a1.812 1.812 0 0 1 1.924.233 234.533 234.533 0 0 0 9.132 7.16 1.884 1.884 0 0 1-.162 3.126 301.407 301.407 0 0 1-45.89 21.83 1.875 1.875 0 0 0-1 2.611 391.055 391.055 0 0 0 30.014 48.815 1.864 1.864 0 0 0 2.063.7A486.048 486.048 0 0 0 610.7 405.729a1.882 1.882 0 0 0 .765-1.352c12.264-126.783-20.532-236.912-86.934-334.541ZM222.491 337.58c-28.972 0-52.844-26.587-52.844-59.239s23.409-59.241 52.844-59.241c29.665 0 53.306 26.82 52.843 59.239 0 32.654-23.41 59.241-52.843 59.241Zm195.38 0c-28.971 0-52.843-26.587-52.843-59.239s23.409-59.241 52.843-59.241c29.667 0 53.307 26.82 52.844 59.239 0 32.654-23.177 59.241-52.844 59.241Z" /></svg>
</a>
<a href="https://github.com/Placeholder-Software/Dissonance" target="_blank" rel="noopener" title="github.com" class="md-social__link">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 496 512"><path d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6zm-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3zm44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9zM244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8zM97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1zm-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7zm32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1zm-11.4-14.7c-1.6 1-1.6 3.6 0 5.9 1.6 2.3 4.3 3.3 5.6 2.3 1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2z" /></svg>
</a>
</div>
</div>
</div>
</footer>
</div>
<div class="md-dialog" data-md-component="dialog">
<div class="md-dialog__inner md-typeset"></div>
</div>
<script id="__config" type="application/json">{"base": "..", "features": ["navigation.instant", "toc.integrate"], "search": "../assets/javascripts/workers/search.ecf98df9.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version.title": "Select version"}}</script>
<script src="../assets/javascripts/bundle.9c69f0bc.min.js"></script>
<script src="../javascript/redirector.js"></script>
</body>
* Connection #0 to host placeholder-software.co.uk left intact
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment