disjunto / zwift-widgets

A widget overlay application for displaying additional data & metrics on Zwift activities.

Zwift Widgets

A widget overlay application for displaying additional data & metrics on Zwift activities.

Requirements

Running this application has the following external requirements:

• For Windows, a WinPCap implementation such as Win10Pcap , WinPcap, or Npcap.

Contributing

Changes and contributions to this project are encouraged, and can be made by raising a pull request.

Set Up

This is an Electron application, as as such makes use of many javascrip technologies; namely yarn and typescript.

For local development, it is likely you will only need the following commands:

• yarn -- Install require JS dependencies
• yarn lint -- Verify your changes comply to the project standars
• yarn start -- Build and run the application locally
• yarn restart -- Run the most recently built version

Standards

While Standards are not yet documented or fully enforced with eslint configuration, it is expected all code written is aligned with similar styles and conventions. This applies to code, changelogs, and commit messages.

Raising a Pull Request

Any work wishing to be included in the project must be introduced through a pull request. This pull request:

• MUST contain an overview of the changes being made.
• MUST describe why these changes being made.
• MUST contain screenshots for and visual changes.
• MAY contain any additional information deemed relevent.
• MUST contain the issue number in the title.

This work will be reviewed by the core team, with one of the following outcomes:

• Your work will be merged into the core codebase.
• Your pull request will be declined, with a comment explaining the reasoning.
• Your work will be modified by the core team, and the merge.
  • This may require declining your original pull request.

Features

This application currently contains widgets for:

• Predicted finish times
• Custom split distances

Upcoming

• Widget configuration
• Distributable packages
  • Currently contains misconfigured electron-builder implementation
• (Running) incline display
• (Running) power display
• Route detection & predictions
• (Cycling) power based predictions

Licensing & Copyright

Please see the LICENSE file contained without this source code.