https://github.com/daleblackwood/spreadjam

An OBS-based Game Jam timer and video measurer
https://github.com/daleblackwood/spreadjam

Last synced: 15 days ago
JSON representation

An OBS-based Game Jam timer and video measurer

• Host: GitHub
• URL: https://github.com/daleblackwood/spreadjam
• Owner: daleblackwood
• License: mit
• Created: 2021-12-21T09:31:40.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2024-09-20T02:35:06.000Z (4 months ago)
• Last Synced: 2024-12-15T20:57:11.545Z (21 days ago)
• Language: Lua
• Size: 36.1 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# SpreadJam Timer

*Count up or down cumulative game jam footage - especially for SpreadJams.*

The **SpreadJam Timer** is a tool for assisting in conducting a SpreadJam game jam or tracking production of a prototype.

**This tool can be used to:**

 - Take part in [SpreadJam](./SpreadJam.md) game jams

 - Time the production of 6, 8 or 12 hour prototypes

 - Count accumulated OBS footage

The tool calculates the total duration of OBS ouput, and adds the current recording time (giving you a running total of recorded footage) and displays it in the corner of your OBS footage.

## What is SpeadJam?

**SpreadJam** comes as a ruleset for a game making challenge and this utility for OBS that, when combined, allow for a game making challenge to be spread-out over multiple sittings. [For information on conducting SpreadJam game jams check out this doc within this repository.](./SpreadJam.md)

## Getting Started

Spreadjams require the software in this repository and OBS. All tools should be available for most Operating Systems.

1. Download and install [OBS](https://obsproject.com/download) screen recorder.

2. Download [this tool](https://github.com/daleblackwood/spreadjam/archive/refs/heads/main.zip) and extract it somewhere memorable.

3. Open OBS, and open `File > Settings` from the header menu, go down to `Output`. Set the `Output Mode` at the top to `Simple` and set the `Recording Path` field to the folder you wish to place your recordings in. Click `OK` to submit.

4. From the header menu, open `Tools > Scripts`, click the plus `+` button and locate the `SpreadJam.lua` from the folder you extracted it to earlier.

5. You're ready to go. Every video you add to the folder you specified under `Recording Path` will count towards your total jam time.

6. Happy jamming. Have fun. Show me what you made.

## Troubleshooting

### I see *SJ24  Error: Please set recording output path.* instead of a timer.

You're either not in Basic Mode or you haven't set the recording path in basic mode yet. It's important to set it this way so SpreadJam knows where to look for your video length calculations. Follow step 3 under Getting Started again.

### It doesn't seem to be calculating the time of my videos correctly.

Make sure you've got the path set correctly in Basic Mode, following step 3 in Getting Started. If you believe you have and there's an error, file a bug report on [The SpreadJam Github](https://github.com/daleblackwood/spreadjam)