icpc / live-v3

Overlay for competitive programming competitions broadcasts

live-v3

Welcome to the ICPC Live Source Code Repository.

Run release version

• Download release from https://github.com/icpc/live-v3/releases

  • You can download latest dev build instead if you are brave enough

• Create contest config files

• (Optional) Tune imported data, so it looks better

• Run java -jar /path/to/jar/file --config-directory=/path/to/config/directory

  Check for more options by running java -jar /path/to/jar/file without arguments. Here is the couple most useful

  • --creds=creds.json -- The path to the credential file. It can be used to avoid storing credentials in the main config file.
  • --no-auth -- Disable auth in admin interface. It's useful if you are running the overlayer on localhost.
  • -p 8080 -- 8080 is default port to listen, but it can be changed.
  • --widget-positions=filename -- customize positions of each widget, see examples in config/widget_positions.json.*
  • --visual-config=filename -- customize colors, sizes, captions and other, see examples in config/visualConfig.json.*

• (Optional) Check imported contest data

• Add a source to OBS

  • +Source
  • Browser
  • URL http://localhost:8080/overlay?noStatus
  • W H 1920x1080
  • OBS Custom css:

  #root > div {
      background: unset;
  }

• Use admin interface in your browser to control overlay

• Check general broadcast production schema for other details of typical setup

• Check emulation mode part of development doc for testing your setup before the contest started.

• Check troubleshooting guide is something looks wrong.

• Read our awesome auto-generated documentation for extensive settings.json and advanced.json usage.

Authorisation

For now http basic auth is used. If you try to login with user, which does not exist, it will be automatically created. First created receives admin rights. Others only receive them when someone with admin rights confirms, it's okay.

Consider, if you are okay with passing your passwords using plain HTTP.

If you don't need auth, you can disable it by --no-auth command-line option.

Using as a library

Check separate document

Run in development mode

Check separate document

Previous versions:

• https://github.com/icpc-live
• https://github.com/Aksenov239/icpc-live-v2

Other repos:

• Script that collects competitive programming historical data for analytical information
• Autoanalyst
• OBS Video Scheduler Plugin with web interface
• Outdated OBS plugin for shared memory (dll)

For more information, email [e-mail]