vtally
Version:
An affordable and reliable Tally Light that works via WiFi based on NodeMCU / ESP8266. Supports multiple video mixers.
718 lines (424 loc) • 23.1 kB
HTML
<html lang="en" class="no-js">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<meta name="description" content="A low-cost, high-reliable Open Source WiFi Tally Light">
<link rel="canonical" href="https://wifi-tally.github.io/download.html">
<link rel="icon" href="images/favicon.png">
<meta name="generator" content="mkdocs-1.2.3, mkdocs-material-8.1.9">
<title>Installation - vTally – Open Source Tally Light</title>
<link rel="stylesheet" href="assets/stylesheets/main.2b4465f4.min.css">
<link rel="stylesheet" href="assets/stylesheets/palette.e6a45f82.min.css">
<script>__md_scope=new URL(".",location),__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="" data-md-color-primary="none" data-md-color-accent="none">
<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="#installation" 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="vTally – Open Source Tally Light" class="md-header__button md-logo" aria-label="vTally – Open Source Tally Light" data-md-component="logo">
<img src="images/logo.png" alt="logo">
</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">
vTally – Open Source Tally Light
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
Installation
</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/wifi-tally/wifi-tally/" 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 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
</div>
<div class="md-source__repository">
GitHub
</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" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href="index.html" title="vTally – Open Source Tally Light" class="md-nav__button md-logo" aria-label="vTally – Open Source Tally Light" data-md-component="logo">
<img src="images/logo.png" alt="logo">
</a>
vTally – Open Source Tally Light
</label>
<div class="md-nav__source">
<a href="https://github.com/wifi-tally/wifi-tally/" 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 448 512"><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"/></svg>
</div>
<div class="md-source__repository">
GitHub
</div>
</a>
</div>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="index.html" class="md-nav__link">
Open Source Tally Light
</a>
</li>
<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">
Installation
<span class="md-nav__icon md-icon"></span>
</label>
<a href="download.html" class="md-nav__link md-nav__link--active">
Installation
</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="#windows" class="md-nav__link">
Windows
</a>
<nav class="md-nav" aria-label="Windows">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#autostart" class="md-nav__link">
Autostart
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#macos-x86_64" class="md-nav__link">
MacOS (x86_64)
</a>
</li>
<li class="md-nav__item">
<a href="#linux-x86_64-ubuntu-debian-fedora-etc" class="md-nav__link">
Linux (x86_64), Ubuntu, Debian, Fedora, etc.
</a>
</li>
<li class="md-nav__item">
<a href="#run-from-npm" class="md-nav__link">
Run from npm
</a>
<nav class="md-nav" aria-label="Run from npm">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#1-install-nodejs-14" class="md-nav__link">
1. Install Node.js ≥14
</a>
</li>
<li class="md-nav__item">
<a href="#2-install-vtally" class="md-nav__link">
2. Install vTally
</a>
</li>
<li class="md-nav__item">
<a href="#3-run-vtally" class="md-nav__link">
3. Run vTally
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="protocol.html" class="md-nav__link">
Protocol
</a>
</li>
<li class="md-nav__item">
<a href="tally.html" class="md-nav__link">
Tally
</a>
</li>
<li class="md-nav__item">
<a href="troubleshooting.html" class="md-nav__link">
Troubleshooting
</a>
</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">
Getting started
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" aria-label="Getting started" data-md-level="1">
<label class="md-nav__title" for="__nav_6">
<span class="md-nav__icon md-icon"></span>
Getting started
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="getting-started/index.html" class="md-nav__link">
Getting started
</a>
</li>
<li class="md-nav__item">
<a href="getting-started/setup-hub.html" class="md-nav__link">
Set up the hub
</a>
</li>
<li class="md-nav__item">
<a href="getting-started/setup-web-tally.html" class="md-nav__link">
Set up a Web Tally
</a>
</li>
<li class="md-nav__item">
<a href="getting-started/setup-wifi-tally.html" class="md-nav__link">
Build and set up a WiFi Tally
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<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="#windows" class="md-nav__link">
Windows
</a>
<nav class="md-nav" aria-label="Windows">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#autostart" class="md-nav__link">
Autostart
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#macos-x86_64" class="md-nav__link">
MacOS (x86_64)
</a>
</li>
<li class="md-nav__item">
<a href="#linux-x86_64-ubuntu-debian-fedora-etc" class="md-nav__link">
Linux (x86_64), Ubuntu, Debian, Fedora, etc.
</a>
</li>
<li class="md-nav__item">
<a href="#run-from-npm" class="md-nav__link">
Run from npm
</a>
<nav class="md-nav" aria-label="Run from npm">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#1-install-nodejs-14" class="md-nav__link">
1. Install Node.js ≥14
</a>
</li>
<li class="md-nav__item">
<a href="#2-install-vtally" class="md-nav__link">
2. Install vTally
</a>
</li>
<li class="md-nav__item">
<a href="#3-run-vtally" class="md-nav__link">
3. Run vTally
</a>
</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/wifi-tally/wifi-tally/edit/master/documentation/docs/download.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 id="installation">Installation<a class="headerlink" href="#installation" title="Permanent link">¶</a></h1>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>We use <a href="https://semver.org/">semantic versioning</a>.</p>
<p>This means</p>
<ul>
<li>We believe the code is stable enough to be used for production</li>
<li>everything before version 1.0.0 could be changed at any time without prior notice.
You should expect pinouts to change, features to dissapear, etc. with any upgrade</li>
<li>We maintain a changelog that will notify you of significant changes</li>
<li>Starting with version 1.0.0 the layout and features can be considered stable in a sense
that they might be improved, but in a backward compatible way</li>
</ul>
</div>
<p>The latest version of vTally is <a href="https://github.com/wifi-tally/wifi-tally/releases/tag/0.5.2">0.5.2</a>.</p>
<h2 id="windows">Windows<a class="headerlink" href="#windows" title="Permanent link">¶</a></h2>
<p>Download <a href="https://github.com/wifi-tally/wifi-tally/releases/download/0.5.2/vtally-0.5.2-win-x64-portable.exe">vtally-0.5.2-win-x64-portable.exe</a>.</p>
<p>Windows Defender might complain multiple times, that it can not verify the source. Just be stubborn.</p>
<p>It does not require installation. Just double-click, and a tray icon should pop up. Right click and select
"Open in Browser", and you see the hub.</p>
<p>To exit vTally, right click the tray icon, click "Exit" and confirm.</p>
<h3 id="autostart">Autostart<a class="headerlink" href="#autostart" title="Permanent link">¶</a></h3>
<p>Hit <code>WIN</code> + <code>R</code> on your keyboard and type <code>shell:Startup</code>. Move the exe file, you downloaded, into this directory.</p>
<p>When you restart your PC and log in again, vTally should automatically start.</p>
<h2 id="macos-x86_64">MacOS (x86_64)<a class="headerlink" href="#macos-x86_64" title="Permanent link">¶</a></h2>
<p>Download <a href="https://github.com/wifi-tally/wifi-tally/releases/download/0.5.2/vtally-0.5.2-mac-x64.dmg">vtally-0.5.2-mac-x64.dmg</a>.</p>
<p>To start the app, right click and select <code>open</code>.</p>
<p>A tray icon should pop up. Right click and select "Open in Browser", and you see the hub.</p>
<p>To exit vTally, right click the tray icon, click "Exit" and confirm.</p>
<h2 id="linux-x86_64-ubuntu-debian-fedora-etc">Linux (x86_64), Ubuntu, Debian, Fedora, etc.<a class="headerlink" href="#linux-x86_64-ubuntu-debian-fedora-etc" title="Permanent link">¶</a></h2>
<p>Download <a href="https://github.com/wifi-tally/wifi-tally/releases/download/0.5.2/vtally-0.5.2-linux-x86_64.AppImage">vtally-0.5.2-linux-x86_64.AppImage</a>,
open a terminal and make it executable:</p>
<pre><code class="language-bash">chmod a+x vtally-0.5.2-linux-x86_64.AppImage
</code></pre>
<p>To start, run</p>
<pre><code class="language-bash">./vtally-0.5.2-linux-x86_64.AppImage
</code></pre>
<p>Point your browser to <a href="http://localhost:3000">http://localhost:3000</a> to show the Hub.</p>
<p>Quit by tapping <code>CTRL</code> + <code>c</code> on your keyboard in the terminal window.</p>
<h2 id="run-from-npm">Run from npm<a class="headerlink" href="#run-from-npm" title="Permanent link">¶</a></h2>
<h3 id="1-install-nodejs-14">1. Install Node.js ≥14<a class="headerlink" href="#1-install-nodejs-14" title="Permanent link">¶</a></h3>
<p><a href="https://nodejs.org/en/download/package-manager/">Install Node.js</a>.</p>
<p>Verify your installation. NodeJS should at least be at version 14. If this is not the
case, <a href="https://nodejs.org/en/download/">check their website</a> for alternative ways of installation.</p>
<pre><code>$ node -v
v14.15.4
$ npm -v
6.14.10
</code></pre>
<h3 id="2-install-vtally">2. Install vTally<a class="headerlink" href="#2-install-vtally" title="Permanent link">¶</a></h3>
<p>This command will install vTally for the logged-in user and does not require <code>sudo</code> rights. Run</p>
<pre><code class="language-bash">npm config set prefix '~/.local/'
echo 'export PATH=~/.local/bin/:$PATH' >> ~/.bashrc
source ~/.bashrc
npm install -g vtally:0.5.2
</code></pre>
<h3 id="3-run-vtally">3. Run vTally<a class="headerlink" href="#3-run-vtally" title="Permanent link">¶</a></h3>
<p>vTally is installed. Run it by calling</p>
<pre><code>vtally
</code></pre>
<p>This version does not come with the tray icon. Point your browser to <a href="http://localhost:3000">http://localhost:3000</a> to see the hub.</p>
</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: Open Source Tally Light" 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>
Open Source Tally Light
</div>
</div>
</a>
<a href="protocol.html" class="md-footer__link md-footer__link--next" aria-label="Next: Protocol" rel="next">
<div class="md-footer__title">
<div class="md-ellipsis">
<span class="md-footer__direction">
Next
</span>
Protocol
</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">
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://github.com/wifi-tally" target="_blank" rel="noopener" title="github.com" class="md-social__link">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 480 512"><path d="M186.1 328.7c0 20.9-10.9 55.1-36.7 55.1s-36.7-34.2-36.7-55.1 10.9-55.1 36.7-55.1 36.7 34.2 36.7 55.1zM480 278.2c0 31.9-3.2 65.7-17.5 95-37.9 76.6-142.1 74.8-216.7 74.8-75.8 0-186.2 2.7-225.6-74.8-14.6-29-20.2-63.1-20.2-95 0-41.9 13.9-81.5 41.5-113.6-5.2-15.8-7.7-32.4-7.7-48.8 0-21.5 4.9-32.3 14.6-51.8 45.3 0 74.3 9 108.8 36 29-6.9 58.8-10 88.7-10 27 0 54.2 2.9 80.4 9.2 34-26.7 63-35.2 107.8-35.2 9.8 19.5 14.6 30.3 14.6 51.8 0 16.4-2.6 32.7-7.7 48.2 27.5 32.4 39 72.3 39 114.2zm-64.3 50.5c0-43.9-26.7-82.6-73.5-82.6-18.9 0-37 3.4-56 6-14.9 2.3-29.8 3.2-45.1 3.2-15.2 0-30.1-.9-45.1-3.2-18.7-2.6-37-6-56-6-46.8 0-73.5 38.7-73.5 82.6 0 87.8 80.4 101.3 150.4 101.3h48.2c70.3 0 150.6-13.4 150.6-101.3zm-82.6-55.1c-25.8 0-36.7 34.2-36.7 55.1s10.9 55.1 36.7 55.1 36.7-34.2 36.7-55.1-10.9-55.1-36.7-55.1z"/></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": [], "translations": {"clipboard.copy": "Copy to clipboard", "clipboard.copied": "Copied to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.placeholder": "Type to start searching", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.term.missing": "Missing", "select.version.title": "Select version"}, "search": "assets/javascripts/workers/search.22074ed6.min.js"}</script>
<script src="assets/javascripts/bundle.960e086b.min.js"></script>
</body>
</html>