Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
name: Bug Report
description: File a bug report
title: "[BUG]: your bug report title"
title: "[BUG] Your bug report title"
labels: "maybe: bug"
body:
- type: textarea
Expand Down Expand Up @@ -49,7 +49,9 @@ body:
attributes:
label: Steps until the issue appears
description: "[optional] You can add the steps taken to be able to reproduce your problem."
placeholder: "1. Description of step 1 ...\n2. Description of step 2 ...\n..."
placeholder: "1. Description of step 1 ...\n
2. Description of step 2 ...\n
..."
- type: textarea
id: expected-result
attributes:
Expand Down
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
name: Feature Request
description: Suggest an idea for this project
title: "[SUGGESTION] Your feature request title"
labels: "suggestion"
body:
- type: textarea
id: description
attributes:
label: Description. Please elaborate.
description: A clear and concise description of what new functions to add or improve.
validations:
required: true
- type: textarea
id: benefit
attributes:
label: Who will this benefit?
description: Does this feature apply to a great portion of users?
validations:
required: true
- type: textarea
id: additional-info
attributes:
label: Additional Information
description: "[optional] You may provide additional context or screenshots for us to better understand the need of the feature."
42 changes: 42 additions & 0 deletions .github/ISSUE_TEMPLATE/translate.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
name: Translates
description: Improve code translation
title: "[TRANSLATE] Your bug report title"
labels: "translate"
body:
- type: input
id: language
attributes:
label: Language
#description:
placeholder: eg. english
validations:
required: true
- type: input
id: lang-code
attributes:
label: Language code
description: ""
placeholder: eg. en
- type: textarea
id: translate
attributes:
label: Translate YAML
description: "You can send the YAML file already translated or write it in this section.\n\n
[WARNING] If you want to directly write the translation in this section, the code must start with ```yaml and end with ```. You can use the "Preview" tab to see if the code has been written correctly."
placeholder: "```md\n
home:\n
\tclose: Close the window and stop the code\n
\tcronoTitle: CLOCKS\n
\tcdownTitle: TIMERS\n
\tcdowntimeTitle: TIME UNTIL...\n
\ttwitchextTitle: EXTENSIBLE TWITCH\n
\ttimeTitle: CURRENT TIME\n
\tnotycopycrono: URL copied to clipboard\n
crono:\n
\tbuttons:\n
\t\tstart: Start\n
\t\tpause: Pause\n
\t\treset: Reset\n
```"
validations:
require: true
58 changes: 43 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,42 +3,70 @@
<h2 align="center">This repository is used for creating dynamic browser sources related to timers, ideal for use in OBS (Open Broadcaster Software).</h2>

<div align="center">
<img alt="GitHub package.json version" src="https://img.shields.io/github/package-json/v/BrowserSourcesForOBS/obs-timer-controller?style=for-the-badge&link=https%3A%2F%2Fgithub.com%2FBrowserSourcesForOBS%2Fobs-timer-controller">
<img alt="GitHub last commit (by committer)" src="https://img.shields.io/github/last-commit/BrowserSourcesForOBS/obs-timer-controller?style=for-the-badge&link=https%3A%2F%2Fgithub.com%2FBrowserSourcesForOBS%2Fobs-timer-controller">
<img alt="GitHub release (latest by SemVer including pre-releases)" src="https://img.shields.io/github/downloads-pre/BrowserSourcesForOBS/obs-timer-controller/latest/total?style=for-the-badge&link=https%3A%2F%2Fgithub.com%2FBrowserSourcesForOBS%2Fobs-timer-controller%2freleases%2Flatest">
<a href="https://github.com/BrowserSourcesForOBS/obs-timer-controller">
<img src="https://img.shields.io/github/package-json/v/BrowserSourcesForOBS/obs-timer-controller?style=for-the-badge" alt="GitHub package.json version" style="vertical-align:middle">
</a>
<a href="https://github.com/BrowserSourcesForOBS/obs-timer-controller">
<img src="https://img.shields.io/github/last-commit/BrowserSourcesForOBS/obs-timer-controller?style=for-the-badge" alt="GitHub last commit (by committer)" style="vertical-align:middle">
</a>
<br>
<img alt="GitHub watchers" src="https://img.shields.io/github/watchers/BrowserSourcesForOBS/obs-timer-controller?style=for-the-badge&link=https%3A%2F%2Fgithub.com%2FBrowserSourcesForOBS%2Fobs-timer-controller">
<img alt="GitHub forks" src="https://img.shields.io/github/forks/BrowserSourcesForOBS/obs-timer-controller?style=for-the-badge&link=https%3A%2F%2Fgithub.com%2FBrowserSourcesForOBS%2Fobs-timer-controller">
<img alt="GitHub Repo stars" src="https://img.shields.io/github/stars/BrowserSourcesForOBS/obs-timer-controller?style=for-the-badge&link=https%3A%2F%2Fgithub.com%2FBrowserSourcesForOBS%2Fobs-timer-controller">
<a href="https://github.com/BrowserSourcesForOBS/obs-timer-controller">
<img src="https://img.shields.io/github/watchers/BrowserSourcesForOBS/obs-timer-controller?style=for-the-badge" alt="GitHub watchers" style="vertical-align:middle">
</a>
<a href="https://github.com/BrowserSourcesForOBS/obs-timer-controller">
<img src="https://img.shields.io/github/forks/BrowserSourcesForOBS/obs-timer-controller?style=for-the-badge" alt="GitHub forks" style="vertical-align:middle">
</a>
<a href="https://github.com/BrowserSourcesForOBS/obs-timer-controller">
<img src="https://img.shields.io/github/stars/BrowserSourcesForOBS/obs-timer-controller?style=for-the-badge" alt="GitHub Repo stars" style="vertical-align:middle">
</a>
<br>
<br>
<img alt="Made with NodeJS" src="https://img.shields.io/badge/MADE%20WITH-NodeJS-yellow?style=for-the-badge&logo=javascript&link=https%3A%2F%2Fnodejs.org">
<img alt="Made with HTML" src="https://img.shields.io/badge/MADE%20WITH-HTML-orange?style=for-the-badge&logo=html5">
<img alt="Made with CSS" src="https://img.shields.io/badge/MADE%20WITH-CSS-blue?style=for-the-badge&logo=css3">
<a href="https://github.com/BrowserSourcesForOBS/obs-timer-controller/releases/latest">
<img src="https://img.shields.io/github/v/tag/BrowserSourcesForOBS/obs-timer-controller?style=for-the-badge&label=LATEST%20RELEASE%20VERSION" alt="GitHub tag (with filter)" style="vertical-align:middle">
</a>
<a href="https://github.com/BrowserSourcesForOBS/obs-timer-controller/releases/latest">
<img src="https://img.shields.io/github/downloads/BrowserSourcesForOBS/obs-timer-controller/total?style=for-the-badge" alt="GitHub all releases" style="vertical-align:middle">
</a>
<br>
<img alt="NodeJS version" src="https://img.shields.io/badge/VERSION-18.18.0%20LTS-yellow?style=for-the-badge&logo=javascript&link=https%3A%2F%2Fnodejs.org%2Fes%2Fdownload">
<img alt="npm version" src="https://img.shields.io/badge/VERSION-10.2.0-red?style=for-the-badge&logo=npm&link=https%3A%2F%2Fwww.npmjs.com">
<br>
<br>
<a href="https://nodejs.org/en">
<img src="https://img.shields.io/badge/MADE%20WITH-NodeJS-yellow?style=for-the-badge&logo=javascript" alt="Made with NodeJS" style="vertical-align:middle">
</a>
<a>
<img src="https://img.shields.io/badge/MADE%20WITH-HTML-orange?style=for-the-badge&logo=html5" alt="Made with HTML" style="vertical-align:middle">
</a>
<a>
<img src="https://img.shields.io/badge/MADE%20WITH-CSS-blue?style=for-the-badge&logo=css3" alt="Made with CSS" style="vertical-align:middle">
</a>
<br>
<a href="https://nodejs.org/en/download">
<img src="https://img.shields.io/badge/VERSION-18.18.0%20LTS-yellow?style=for-the-badge&logo=javascript" alt="NodeJS version" style="vertical-align:middle">
</a>
<a href="https://nodejs.org/en/download">
<img src="https://img.shields.io/badge/VERSION-10.2.0-red?style=for-the-badge&logo=npm" alt="npm version" style="vertical-align:middle">
</a>
</div>

## Collaborators
## :busts_in_silhouette: Collaborators

<div align="center"><h3><a href="https://github.com/XtoMHA96"><img src="https://github.com/XtoMHA96.png?size=50" alt="" style="vertical-align:middle; border-radius:50%" height="50"></a><span style="display:inline-block; width: 10px;"></span> <a href="https://github.com/XtoMHA96"><b>XtoManuel</b></a></h3></div>
<!--&nbsp;&nbsp;&nbsp;&nbsp;-->

___

### Description
### :clipboard: Description

This code allows you to create timers, countdowns, countdowns to a specific time, and display the current time. Each of these features comes with a browser source for OBS, which you can preview in your browser and configure to your needs.

One of the additional functions of this repository is the ability to modify the timers through events sent from a StreamDeck or a similar tool using websockets.

### About the Code
### :keyboard: About the Code

I have chosen to publish this code to make it accessible for free, openly, and as open-source. These codes I have developed have helped me continue learning, and since it doesn't entail any financial cost for me, there will also be no paid features created. It will be open to anyone who wants to use it and collaborate in improving the code.

The codes have been created with my current knowledge and may contain errors or areas that need improvement. I have worked on this code in my free time.

### Documentation
### :book: Documentation

~~WIKI~~ (In construction)