Skip to content
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.

Sign up for GitHub

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

Add RFC: Scene setup wizard #32

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add RFC: Scene setup wizard #32

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
36 changes: 36 additions & 0 deletions accepted/0032-scene-wizard.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
- Start Date: 2020-09-10
- RFC PR: #32

# Summary

This proposal is for adding a scene wizard for new users when first loading OBS.

# Motivation

Users often find it difficult to set up OBS.

# Detailed Design

The user will also be able to open the wizard in the scene collection menu.

### Wizard page 1
- Buttons that allow the user to select how they want to use OBS
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think stylised buttons would be good - big icon, short text. Make it SUPER user-friendly - this'll be their first interaction with the program.

1. "I just want to record my screen"
2. "I want to use a scene template"
3. "I will set up OBS myself" (if they select this then exit wizard)

- The scene templates would be just pre-made scene collections

### Wizard page 2
- If the user selects scene template, show them different scene collections they could choose from
- The scene collections will have image previews as well
- If the user selects screen recording, ask them what monitor they want to record
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We'd have to be extra clear here for a couple reasons:

  1. When people say "my screen", sometimes they mean "Photoshop" or a game.
  2. On a laptop on Windows, "choosing a monitor" will result in no input, causing confusion (until the GPU is toggled)


### Wizard page 3
- Have the user select their microphone and webcam
- The webcam would have a preview
- The microphone would also show a volume meter
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd personally vote that this should be where we include other basic things like choosing default microphone filters (ideally, at least, a noise suppression filter & a compressor). We should also make it super clear to the user if their mic is peaking.

Speaking of peaking, I wonder if it'd be possible to determine what a device's system volume is in dB. Windows does have the UI for it, and being able to notify a user that their mic is "above the recommended range" (ie above 0dB).
image

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One easy way to include the filters, is to have them in the scene template, which is just a scene collection.


# Additional Information

- Should it be a seperate wizard than the auto-config? Or combined into a single wizard?
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think a combined wizard would be preferred, and steps should be clearly skippable. We don't want to overwhelm the user, and spamming them with new popups after each "mini-wizard" is complete would not be a good experience.