Skip to content

Issue forms #129

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Feb 14, 2022
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
22 changes: 22 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
name: Bug report
about: Report a bug to help us improve
title: "SHORT DESCRIPTION"
labels: bug
assignees: ''

---

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

# Code Sample
```java
// give a code sample showing how to reproduce this.
```

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

# Additional context
Add any other context about the problem here.
43 changes: 43 additions & 0 deletions .github/ISSUE_TEMPLATE/missing-event.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
name: Missing Event
description: Request Implementation of a missing event
labels: [ "missing event" ]

body:
- type: input
id: eventName
attributes:
label: Event Name
description: Name of the event
placeholder: SceneCreated
validations:
required: true

- type: input
id: docLink
attributes:
label: Documentation
description: Link to the Event Documentation
validations:
required: true

- type: textarea
id: eventFields
attributes:
label: Event Fields
description: |
Fields send with the Event

Tip: Use the given example table to list the fields
value: |
| Name | Type |
| ------------- | :-------------: |
| `exampleField` | String |
| `exampleField2` | int |
validations:
required: true

- type: textarea
id: additional-info
attributes:
label: Additional Info
description: Other usefull information like links to a Event handler etc.
55 changes: 55 additions & 0 deletions .github/ISSUE_TEMPLATE/missing-request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
name: Missing Request
description: Request implementation of a missing request
labels: [ "missing request" ]

body:
- type: input
id: requestName
attributes:
label: Request Name
description: Name of the request
placeholder: GetVersion
validations:
required: true

- type: input
id: docLink
attributes:
label: Documentation
description: Link to the Request Documentation
validations:
required: true

- type: textarea
id: requestParameters
attributes:
label: Request Parameters
description: |
Tip: Use the given example table to list the parameters
value: |
| Name | Type | Required |
| ------------- | :-------------: | :-------------: |
| `exampleParameter` | String | yes |
| `exampleParameter2` | int | no |
validations:
required: true

- type: textarea
id: responseParameters
attributes:
label: Response Parameters
description: |
Tip: Use the given example table to list the parameters
value: |
| Name | Type |
| ------------- | :-------------: |
| `exampleResponse` | String |
| `exampleResponse2` | int |
validations:
required: true

- type: textarea
id: additional-info
attributes:
label: Additional Info
description: Other usefull information like links to a Request handler etc.
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -170,6 +170,32 @@ The current version of the library (2.0.0+) is published under `io.obs-websocket

There are several key differences to be aware of, for full details please see the [current protocol](https://github.com/Palakis/obs-websocket/blob/master/docs/generated/protocol.md) for Palakis OBS Websocket.

### 📘 Notice to Developers: Repository Transfer 📘
On June 21st, 2021, this repository was transferred from the `Twasi` Organization to the
`obs-websocket-community-projects` Organization. This was done to better align this library with the
greater Palakis' OBS Websocket plugin community, and provide better administrative tools.

Remotes will continue to operate as normal, due to GitHub automatic redirects. However, to avoid
confusion GitHub strongly recommends you update those remotes.

If you haven't updated your remote, you can check like so; the below example shows an old remote:
```
C:\Users\...\websocket-obs-java>git remote -v
origin https://github.com/Twasi/websocket-obs-java.git (fetch)
origin https://github.com/Twasi/websocket-obs-java.git (push)
```
You can update and verify your remote is correct like this:
```
C:\Users\...\websocket-obs-java>git remote set-url origin https://github.com/obs-websocket-community-projects/websocket-obs-java.git
(no output)
C:\Users\...\websocket-obs-java>git remote -v
origin https://github.com/obs-websocket-community-projects/websocket-obs-java.git (fetch)
origin https://github.com/obs-websocket-community-projects/websocket-obs-java.git (push)
```
See [Transferring a repository](https://docs.github.com/en/github/administering-a-repository/managing-repository-settings/transferring-a-repository)
for more information.


### Requests, Events, and Subscriptions
Most events and requests changed between the two libraries, due to changes in the OBS Websocket protocol. You can view the [current protocol](https://github.com/Palakis/obs-websocket/blob/master/docs/generated/protocol.md) for the full list of available requests and events.

Expand Down