diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS new file mode 100644 index 0000000..0db8622 --- /dev/null +++ b/.github/CODEOWNERS @@ -0,0 +1 @@ +.github/* @klaasnicolaas diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml new file mode 100644 index 0000000..32a0d14 --- /dev/null +++ b/.github/FUNDING.yml @@ -0,0 +1,2 @@ +--- +github: klaasnicolaas diff --git a/.github/labels.yml b/.github/labels.yml new file mode 100644 index 0000000..ca7f64d --- /dev/null +++ b/.github/labels.yml @@ -0,0 +1,100 @@ +--- +- name: "breaking-change" + color: d93f0b + description: "A breaking change for existing users." +- name: "bug" + color: fc2929 + description: "Inconsistencies or issues which will cause a problem for users." +- name: "bugfix" + color: ededed + description: "Fixing a bug." +- name: "documentation" + color: 0052cc + description: "Solely about the documentation of the project." +- name: "enhancement" + color: 1d76db + description: "Enhancement of the code, not introducing new features." +- name: "refactor" + color: 1d76db + description: "Improvement of existing code, not introducing new features." +- name: "performance" + color: 1d76db + description: "Improving performance, not introducing new features." +- name: "new-feature" + color: 0e8a16 + description: "New features or request." +- name: "maintenance" + color: 2af79e + description: "Generic maintenance tasks." +- name: "ci" + color: 1d76db + description: "Work that improves the continue integration." +- name: "dependencies" + color: 1d76db + description: "Upgrade or downgrade of project dependencies." + +- name: "in-progress" + color: fbca04 + description: "Issue is currently being resolved by a developer." +- name: "stale" + color: fef2c0 + description: "There has not been activity on this issue or PR for quite some time." +- name: "no-stale" + color: fef2c0 + description: "This issue or PR is exempted from the stable bot." +- name: "wontfix" + color: ffffff + description: "This issue or PR will not be fixed." +- name: "cleanup" + color: ef75d5 + description: "Cleanup of code." +- name: "sync" + color: 00a6ed + description: "Syncing with upstream github config repository." + +- name: "security" + color: ee0701 + description: "Marks a security issue that needs to be resolved asap." +- name: "incomplete" + color: fef2c0 + description: "Marks a PR or issue that is missing information." +- name: "invalid" + color: fef2c0 + description: "Marks a PR or issue that is missing information." +- name: "duplicate" + color: cfd3d7 + description: "This issue or pull request already exists." + +- name: "beginner-friendly" + color: 0e8a16 + description: "Good first issue for people wanting to contribute to the project." +- name: "help-wanted" + color: 0e8a16 + description: "We need some extra helping hands or expertise in order to resolve this." + +- name: "hacktoberfest" + description: "Issues/PRs are participating in the Hacktoberfest." + color: fbca04 +- name: "hacktoberfest-accepted" + description: "Issues/PRs are participating in the Hacktoberfest." + color: fbca04 + +- name: "priority-critical" + color: ee0701 + description: "This should be dealt with ASAP. Not fixing this issue would be a serious error." +- name: "priority-high" + color: b60205 + description: "After critical issues are fixed, these should be dealt with before any further issues." +- name: "priority-medium" + color: 0e8a16 + description: "This issue may be useful, and needs some attention." +- name: "priority-low" + color: e4ea8a + description: "Nice addition, maybe... someday..." + +- name: "major" + color: b60205 + description: "This PR causes a major version bump in the version number." +- name: "minor" + color: 0e8a16 + description: "This PR causes a minor version bump in the version number." diff --git a/.github/workflows/labels.yaml b/.github/workflows/labels.yaml new file mode 100644 index 0000000..445703e --- /dev/null +++ b/.github/workflows/labels.yaml @@ -0,0 +1,25 @@ +--- +name: Sync labels + +# yamllint disable-line rule:truthy +on: + push: + branches: + - main + paths: + - .github/labels.yml + workflow_dispatch: + +jobs: + labels: + name: ♻️ Sync labels + runs-on: ubuntu-latest + permissions: + pull-requests: write + steps: + - name: ⤵️ Check out code from GitHub + uses: actions/checkout@v4.1.1 + - name: 🚀 Run Label Syncer + uses: micnncim/action-label-syncer@v1.3.0 + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} diff --git a/README.md b/README.md index e46aff1..c1a1507 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,12 @@ -## RotorHazard Stream Overlays + +![alt Header of the Stream Overlays RH plugin](https://raw.githubusercontent.com/dutchdronesquad/rh-stream-overlays/main/assets/header_rh_stream_overlays-min.png) + + +![Project Stage][project-stage-shield] +![Project Maintenance][maintenance-shield] +[![License][license-shield]](LICENSE) + +## About This plugin adds new designed stream overlays to RotorHazard, which can be used in OBS (Open Broadcaster Software). A showcase of all overlays can be [found here](./stream_overlays/). @@ -21,7 +29,7 @@ Do you have any wishes for a new overlay? Then leave your ideas, sketches or moo ### Development -To get started, you obviously need a working development environment from RotorHazard. +To get started, you obviously need a working [development environment][rh-dev] from RotorHazard. 1. Fork / Clone the repository 2. Create a symlink to the stream_overlays folder in the RotorHazard plugin folder @@ -38,4 +46,9 @@ ln -s ~/rh-stream-overlays/stream_overlays/ ~/RotorHazard/src/server/plugins/str Distributed under the **MIT** License. See [`LICENSE`](LICENSE) for more information. -[rh-plugin-docs]: https://github.com/RotorHazard/RotorHazard/blob/main/doc/Plugins.md#installing-and-running \ No newline at end of file +[rh-plugin-docs]: https://github.com/RotorHazard/RotorHazard/blob/main/doc/Plugins.md#installing-and-running +[rh-dev]: https://github.com/RotorHazard/RotorHazard/blob/main/doc/Development.md + +[license-shield]: https://img.shields.io/github/license/dutchdronesquad/rh-stream-overlays.svg +[maintenance-shield]: https://img.shields.io/maintenance/yes/2023.svg +[project-stage-shield]: https://img.shields.io/badge/project%20stage-experimental-yellow.svg diff --git a/assets/header_rh_stream_overlays-min.png b/assets/header_rh_stream_overlays-min.png new file mode 100644 index 0000000..ddf8820 Binary files /dev/null and b/assets/header_rh_stream_overlays-min.png differ