Giter VIP home page Giter VIP logo

toastmasters-timer-overlay's Introduction

Toastmasters Timer Overlay

This is a webpage that can be used as an overlay for the purpose of timing for a Toastmasters meeting

The Overlay is controlled from a local website that is mirrored across all with the same id. The view parameter hides the controls

OBS will hide the background

site Usage


Usage:

  1. Download
  2. Run the Timer Overlay
  3. Open a browser window at localhost:8888
  4. Click Copy Link
  5. Open OBS Studio
  6. Setup your video in OBS
    1. Sources -> Add -> Video Capture Device
    2. Click the image and resize and move it to your liking
  7. Add Browser Capture
    1. Sources -> Add -> Browser
    2. Paste the copied link
  8. Start VirtualCam
    1. (Top Bar) -> Tools -> VirtualCam -> Start
  9. Change your Video Source to OBS-Camera
    • In Zoom: Settings -> Video -> Camera -> OBS-Camera

To run from source:

  1. Download
  2. Run
    1. npm install
    2. npm run build
  3. Start the application with npm start
  4. Continue from step 3 of Usage above

To Develop:

  1. Requirement
  2. Install dependencies
    • npm install
  3. Start webpack in dev mode
    • npm run watch:web
  4. Start with ts-server with cache disabled
    • npm run dev
  5. Open a browser at localhost:8888
    • Optionally the port can be changed by adding port={number} to the run dev command

Arguments

  • Port [number] The port to listen on
  • Cache [number or false] How long the client should cache the page for
  • One-Id [string, boolean on nothing] Forces all ids to be the passed string or the string aaaa if true or nothing is passed
  • Open [string or Nothing] Opens a browser window with optional parameter being the browser to open with

The arguments port=80 cache=false one-id=true

Are the same as 80 false one-id and 80 false true

And would cause the port to be set to 80, caching to be disabled, and all ids to be aaaa

toastmasters-timer-overlay's People

Contributors

rakusan2 avatar dependabot[bot] avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.