Skip to content

Add configurable auto-streak feature with daily increment and source display #5

@bhaskarjha-dev

Description

@bhaskarjha-dev

Feature Overview:

  • Implement an auto streak feature. Once a user starts or resets a streak, the streak count increases by 1 every day until reset.
  • Users should be able to reset the streak at any moment.
  • The current streak value should be available as a source to be shown on stream (OBS Studio display).
  • Consider both browser overlay and text sources for displaying the streak count. Decide which is best or allow user to choose.
  • Users should be able to configure the prefix for the streak number (e.g., 'Day', 'Streak', or any custom prefix).

Requirements:

  • Add feature to automatically increment streak counter daily and persist this value.
  • Add option for user to reset streak (counter returns to 0 or 1).
  • Provide a setting for users to set the prefix shown before the streak number.
  • Present the streak as a source that can be added as overlay or text in OBS Studio (configurable).
  • Update documentation to explain how to use and configure this feature.

Language/Platform:

  • Main implementation in Lua (core logic)
  • UI/overlay part in HTML/JavaScript if using browser sources

Benefits:

  • Helps users track daily progress or habits directly on stream.
  • Fully automated, minimal configuration, and customizable prefix for personal branding.

If you have a preference for overlay type (text vs browser), please specify in a comment.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions