https://github.com/juxt/reco
JUXT OBS Recording & Streaming
https://github.com/juxt/reco
Last synced: 3 months ago
JSON representation
JUXT OBS Recording & Streaming
- Host: GitHub
- URL: https://github.com/juxt/reco
- Owner: juxt
- Created: 2024-10-28T12:32:22.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2024-10-31T15:13:50.000Z (about 1 year ago)
- Last Synced: 2025-10-01T23:39:36.543Z (3 months ago)
- Language: Lua
- Size: 5.14 MB
- Stars: 0
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.adoc
Awesome Lists containing this project
README
= reco
Benjamin Shearlock
v1.0, 2024-10-28
:status: WORKING RECOMMENDATION
:classification: INTERNAL
:reader-nickname: User
:reader-code:
:reader-fullname: User
:toc: macro
== Introduction
Welcome {reader-nickname}
=== Objective
To document the steps to install and configure OBS Studio for streaming and/or recording using the pre-configured JUXT OBS setup.
toc::[]
=== Audience
This document is intended for users who are setting up OBS Studio for the first time. It will help them configure it with the JUXT OBS package.
== Procedure
=== Requirements
* OBS Studio Installer
* JUXT OBS configuration package (JUXT-OBS.zip)
=== OBS Installation and Setup
==== Step 1: Download and Extract the JUXT OBS Package
// Use Pages to link this as a direct download in the future!
Download the JUXT OBS zipped configuration package *link:https://juxt.github.io/reco/OBS-JUXT.zip[OBS-JUXT.zip]* and extract/unzip it to a convenient location on your system. Alternatively, you can just **Clone** this repository and navigate to the `OBS-JUXT` folder within it.
==== Step 2: Install OBS Studio
Go to this *link:https://obsproject.com/[link]* and download the appropriate installer for your operating system. Alternatively, you could also install OBS from your system's "App Store", or via a package manager.
Install OBS Studio following the usual installation process for your system.
==== Step 3: Install the Font
Within the extracted folder, locate the file `InterFace_Trial_Rg.ttf`. To install the font, double-click the file and select **Install**. If your operating system requires a different method to install fonts, follow that method. This is to ensure that there is a consistent font that can work across all operating systems.
==== Step 4: Launch OBS Studio and Initial Setup
Launch OBS Studio. When prompted, select whether you intend to **stream** or **record**. If you are unsure, choose **Recording** for now. Make sure the **Base Canvas Resolution** is set to `1920x1080`. Click **Next** for all other settings.
NOTE: If you selected to stream, provide your Twitch or other streaming service credentials/keys when prompted.
Click **Apply Settings** when finished.
==== Step 5: Import Scene Collection
At the top of the OBS window, click the **Scene Collection** tab. From the dropdown, select **Import**. If prompted to confirm anything, click **Yes**.
Next, in the **Collection Path** column, click the **three dots** and navigate to the folder where you extracted the JUXT OBS package. Select the file `JUXT Scenes.json` and click **Import**.
==== Step 6: Add the JUXT Lua Script
Go to the **Tools** tab at the top of OBS and select **Scripts**. In the bottom left, click the **+** button to add a new script. By default, you'll be taken to the default OBS scripts folder.
Navigate to the extracted JUXT OBS folder and select the file `JUXT Script.lua`. It may cause some **pop-ups** to appear, please **close/click cancel** on any that do.
NOTE: It may also cause OBS to crash or freeze, if so just restart it. Once OBS is running again, open the **Scripts** menu.
On the right-hand side within **Scripts**, you'll see parameters that you can adjust (such as folder selection, text inputs and dropdown lists).
For the **Folder** parameter, navigate once more to the extracted JUXT OBS folder and select it.
==== Step 7: Adjust Scene Information
Once you have entered all the necessary information in the script parameters, you may want to change which screen is being displayed. To do this:
1. Navigate to the **Screen** scene (Ctrl + 4).
2. Scroll down the list of sources until you find the "**Record Screen**" for your operating system.
3. Double-click it to adjust the screen/display you want to record.
If you find that **NONE** of these screens are interactable within your OBS, you may need to add a new screen capturing source. If not, **skip** this section. To do this:
1. Click the **+** button in the **Sources** panel.
2. Select the **Screen Capture** option.
3. Name the source and click **OK**.
4. A pop-up will appear, select the screen you want to capture and click **OK**.
5. Depending on your screen size/resolution, you may see your screen being too large to fit in the scene. Since you should have the screen source still selected, press **Ctrl + S** to resize the screen to fit the scene.
6. At the bottom of sources, you'll see arrows to move the source up and down. Press repeatedly on the **down** arrow until the newly created screen source is at the bottom of the list.
7. Right-click the the newly created screen source and select **Copy**. Then navigate to the **Both** scene, right-click and select **Paste (Reference)** - this can also all be done using keyboard commands for copy & paste.
8. Finally, refer to **Part 6** to ensure that the pasted screen source is at the bottom of the list in the **Both** scene.
==== Step 8: Customize Hotkeys
To customise any hotkeys used in OBS:
1. Go to **Settings** in the bottom-right corner.
2. Select the **Hotkeys** tab from the menu on the left.
3. Adjust hotkeys as needed.
The scene collection comes with pre-configured hotkeys for each scene, which you can use while tabbed out of OBS to swap between scenes.
==== Step 9: Audio Mixer Configuration
The OBS audio mixer should automatically use your default system devices. However, if you need to use a different microphone:
1. Select the **Audio Input Source** in sources.
2. Adjust the microphone input accordingly.
In the **Audio Mixer** panel, you can adjust the volume of each source as needed.
NOTE: Your microphone and computer audio will **NOT** be recorded when you are using the **Intro** and **Outro** scenes.
=== Starting Your Recording or Stream
To begin streaming or recording, use the **Start Streaming** or **Start Recording** buttons located on the far right in the **Controls** panel. These can also be assigned to hotkeys.
=== Further Assistance
If you encounter any issues with the installation or have further questions, please contact @bcs on Slack.
== Next Steps
With OBS setup, you can customise it as needed for your streaming and recording requirements.