Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/main' into main
Browse files Browse the repository at this point in the history
  • Loading branch information
punlife committed Jun 6, 2021
2 parents 32f8536 + 265fb3d commit 305459e
Show file tree
Hide file tree
Showing 4 changed files with 61 additions and 0 deletions.
1 change: 1 addition & 0 deletions .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
ko_fi: punlife
32 changes: 32 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: bug
assignees: punlife

---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error

**Expected behavior**
A clear and concise description of what you expected to happen.

**Screenshots**
If applicable, add screenshots to help explain your problem.

**Desktop (please complete the following information):**
- OS: [e.g. iOS]
- Browser [e.g. chrome, safari]
- Version [e.g. 22]

**Additional context**
Add any other context about the problem here.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: enhancement
assignees: punlife

---

**Is your feature request related to a problem? Please describe.**
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]

**Describe the solution you'd like**
A clear and concise description of what you want to happen.

**Describe alternatives you've considered**
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,12 @@ Hope you enjoy your time using Punduction!

------------------

## Brand assets

I've attached a couple of **Powered by Punduction** logos that you can place on your stream/overlays as a way of supporting the application, this is not in anyway mandatory but it makes me feel warm and fuzzy inside to see the application used across a range of streams. These assets can be found in the **brandAssets** folder.

------------------

## Obtaining API keys for Scoreboard providers

You are required to obtain your own API keys to use with Punduction, I am unable to give you access to my personal keys.
Expand Down Expand Up @@ -58,6 +64,8 @@ https://youtu.be/CJtmCqIRaWw
* **Raw:** Input a CSV file of the following format: **name,prefix,country**. The prefix and country can be empty but please ensure the name is populated.
* If using HTML overlays make sure you press **Start Server** before starting and let the **Console** window run in the background.
* After loading the appropriate data, choose the appropriate players, scores etc. and press save.
* If you're trying to populate the streamqueue, ensure you set it on SmashGG, populate the stream name field with matching stream and press **Update stream queue**. This will load the stream queue and then you can choose a specific set and press **Populate stream queue** to update the player fields with corresponding players.
* You can access the directories of the local server at http://localhost:8080/, from there you can navigate to wherever you placed your overlays and then put the full URL in a browser source in OBS etc.

### Video instructions

Expand Down

0 comments on commit 305459e

Please sign in to comment.