NOTE: FoosOBS is no longer an active project. Try FoosOBSPlus (https://github.com/hsgarn/foosobsplus).
FoosOBS is a flexible foosball score keeper program compatible with OBS Studio and also plays well with Elagto's Stream Deck products.
foosOBS was written to update text files used by OBS Studio to display scores and game counts while live streaming foosball matches. Almost every field displayed in foosOBS can be output to a file that OBS Studio can then read and display in a scene.
foosOBS Main Screen:
OBS Studio scene utilizing foosOBS text files:
foosOBS is a java program. You can download the source and export to a jar file. I do this in eclipse so am not sure how to do it at command line or in other ide's, though I'm sure google is your friend and will provide you with that information. Windows will need to have at least Java 1.8 loaded and set to associate jar files with java.
If running foosOBS for the first time, it will create a config.properties file with the default properties in the folder in which the program is running. These properties contain the settings for the operating parameters, filenames and hot keys.
foosOBS tries to make keeping track of a foosball match's progress as simple as possible. To that end, there is a settings screen that contains parameters that affect how foosOBS will behave. Click the Settings button on the main page to get to the settings screen.
Main Settings Page:
This is the number of points required to win a game. This is only used if the Auto Increment Game checkbox is checked. Once a team's score reaches this number, it will reset to zero and increase the game counter for the team. If the Announce Winner check box is set and the team has reached the number in the Games to Win parameter, then the Team's name will be written to the Match Winner file along with the text specified in the Winner Prefix and Winner Suffix parameters. Points to Win is also utilized to determine if it is meatball (both teams 1 point away from winning score).
The Max Win parameter is only used when the Win By parameter is greater than 1. If a team has to win by more than 1 point, then Max Win is the maximum score a team can get and at that point it does not matter if they won by more than 1 point.
The Win By parameter is used to force a team to win by a specified number of points. Default is 1 which means that a team only has to win by 1 point (normal game behavior). Setting the parameter to 2 would require that a team win by two points. If a team reaches the Points to Win value without being ahead by the Win By value, then the game continues until either a team wins by the Win By margin, or the Max Win value is reached.
The Games to Win parameter is used to determine when a match is one. Specify the number of games required to win the match. Default is 2 for a 2 out of 3 match. Use 3 for a 3 out of 5 match. etc.
The Max Time Outs parameter is used to set how many time outs each team has. The default is 2.
This parameter defines the text that will be put in the Last Scored text file when Team 1 scores. The default value is "<--- Last Scored".
This parameter defines the text that will be put in the Last Scored text file when Team 2 scores. The default value is "Last Scored --->".
This parameter defines the text that will be put in the Last Scored text file when neither team has scored (after the Reset All button is clicked or a score is reduced by the - button).
This parameter is used to set the character used to separate the forward's name from the goalie's name for each team. The default character is /. Everything prior to this character in the Team Name field is the forward's name and everything after this character is the goalie's name. This allows the program to know how to switch the names if the forward and goalie swap places.
This is the time allowed to shoot the ball from the forward 3 rod or the goalie area in seconds. The default is 15 seconds.
This is the time allowed to pass the ball from the 5 row to the 3 row in seconds. The default is 10 seconds.
This is the time allowed for a time out in seconds. The default is 30 seconds.
This is the time allowed between games in seconds. The default is 90 seconds.
This is the number of minutes a player may be on recall before forfeiting the match. The default is 10 minutes.
When checked, the game count for the team that just scored will be automatically incremented when their score is incremented and reaches the number of points required to win a game.
When checked, the Match Winner file will be populated with the winning team name (prefixed by the Winner Prefix parameter and suffixed by the Winner Suffix parameter) when the game count for a team reaches the Games to Win parameter value. Use the Reset Scores or Reset All buttons to clear the Match Winner file for the next match.
When checked, the Meatball file will be populated with the text in the Announce Meatball parameter when both teams' scores are one point away from winning. Once the score changes, the text in the Meatball file will be automatically cleared.
When checked, the program will put the number of time outs remaining for each team in the Time Out files. When unchecked, the program will put the number of time outs used for each team in the Time Out Files. Yes, this is backwards and I will fix this the next time I am in the code.
When checked, the program will automatically capitalize the first letter of each team's player's names. If not checked, the team names are left as entered.
FoosOBS writes out most of it's data to text files so that it can be read by programs such as OBS Studio and displayed in a live video stream. The names of these files are configurable if the default names do not suit you. FoosOBS also allows you to run more than one table at a time. It does this by prefixing each file with the table name. To get to the filenames configuration, click on the Files... button on the Settings window:
Below are the file names that can be configured:
This is the filename for Team 1's name(s). Default filename is team1.txt.
This is the filename for Team 2's name(s). Default filename is team2.txt.
This is the filename for Team 1's game count. Default filename is gamecount1.txt.
This is the filename for Team 2's game count. Default filename is gamecount2.txt.
This is the filename for Team 1's score. Default filename is score1.txt.
This is the filename for Team 2's score. Default filename is score2.txt.
This is the filename for Team 1's time outs used or remaining depending the Show Time Outs Used checkbox. Default filename is timeout1.txt.
This is the filename for Team 2's time outs used or remaining depending the Show Time Outs Used checkbox. Default filename is timeout2.txt.
This is the filename for Team 1's Reset flag. Default filename is reset1.txt.
This is the filename for Team 2's Reset flag. Default filename is reset2.txt.
This is the filename for Team 1's Reset Warning flag. Default filename is warn1.txt.
This is the filename for Team 2's Reset Warning flag. Default filename is warn2.txt.
This is the filename that holds Team 1's player 1's name. Usually this would be the forward player. Default filename is team1name1.txt
This is the filename that holds Team 1's player 2's name. Usually this would be the goalie player. Default filename is team1name2.txt
This is the filename that holds Team 2's player 1's name. Usually this would be the forward player. Default filename is team2name1.txt
This is the filename that holds Team 2's player 2's name. Usually this would be the goalie player. Default filename is team2name2.txt
This is the filename of a freeform text field that can be used for the name of the tournament or venue. Default filename is tournament.txt.
This is the filename of a freeform text field that can be used for the name of the event being played (i.e. DYP, Open Singles, etc). Default filename is event.txt.
This is the filename for the Time Remaining on the current timer. Default filename is timeremaining.txt.
This is the filename that holds the name of the current timer that is running (Shot, Pass, Game, Timeout, Recall). Default filename is timerinuse.txt.
This is the filename that holds the Winner Prefix, Team's Name and Winner Suffix of the team that won the match. Default filename is matchwinner.txt.
This is the filename that holds the Meatball text when a game is tied just prior to the final point. Default filename is meatball.txt.
This is the filename that holds the indicator for which team scored last. Default filename is lastscored.txt.
Click the save button to save any filename changes made.
Click the cancel button to discard any filename changes made.
Click the Restore Defaults button to restore the default filenames.
FoosOBS uses buttons to do various functions such as increase or decrease scores, switch sides, reset game counts, start timers, etc. Each button can have a Hot Key assigned to it. Pressing ALT plus the assigned Hot Key for the button will function just like pressing the actual button. The hot keys can be used in Stream Deck commands to make operating FoosOBS a simple push button affair.
Assigns the hot key for the Clear Tournament button. Default hot key is unassigned.
Assigns the hot key for the Clear Event button. Default hot key is unassigned.
Assigns the hot key for the Reset button for Team 1. Default hot key is z.
Assigns the hot key for the Reset button for Team 2. Default hot key is ,.
Assigns the hot key for the Warn button for Team 1. Default hot key is x.
Assigns the hot key for the Warn button for Team 2. Default hot key is ..
Assigns the hot key to swap the Reset and Warn flags for Team 1 with Team 2. Deafult hot key is not assigned.
Assigns the hot key for the Clear button for Team 1's name. Default hot key is unassigned.
Assigns the hot key to Switch Team 1 and Team 2's names. Default hot key is t.
Assigns the hot key for the Switch button for Team 2's names. Default hot key is m.
Assigns the hot key for the Clear button for Team 2's name. Default hot key is unassigned.
Assigns the hot key to swap Team 1's and Team 2's names with each other. Default hot key is e.
Assigns the hot key for the - button for Team 1's score. Default hot key is unassigned.
Assigns the hot key for the - button for Team 2's score. Default hot key is unassigned.
Assigns the hot key for the + button to increase Team 1's score. Default hot key is 1.
Assigns the hot key for the + button to increase Team 2's score. Default hot key is 2.
Assigns the hot key to Switch Team 1 and Team 2's scores. Default hot key is e.
Assigns the hot key for the - button for Team 1's score. Default hot key is unassigned.
Assigns the hot key for the - button for Team 2's score. Default hot key is unassigned.
Assigns the hot key for the + button to increase Team 1's game count. Default hot key is 5.
Assigns the hot key for the + button to increase Team 2's game count. Default hot key is 6.
Assigns the hot key to switch the game counts. Team 1's game count will be swapped with Team 2's game count. Default hot key is unassigned.
Assigns the hot key to return a time out to Team 1's available pool of timeouts or used pool of time outs depending on how the Show Time Outs Used setting is set. Default hot key is unassigned.
Assigns the hot key to use a time out for Team 1. Default hot key is 9.
Assigns the hot key to return a time out to Team 2's available pool of timeouts or used pool of time outs depending on how the Show Time Outs Used setting is set. Default hot key is unassigned.
Assigns the hot key to use a time out for Team 2. Default hot key is 0.
Assigns the hot key to switch the time out counts. Team 1's time out count will be swapped with Team 2's time out count. Default hot key is unassigned.
Assigns the hot key to swap all Team 1's data with Team 2's data. Use this when the teams switch sides. Default hot key is w.
Assigns the hot key to reset Team 1's and Team 2's game counts to 0. Default hot key is 7.
Assigns the hot key to reset Team 1's and Team 2's scores to 0. Default hot key is 3.
Assigns the hot key to reset Team 1's and Team 2's time outs to 0 or the max time outs depending on how the Show Time Outs Used setting is set. Default hot key is -.
Assigns the hot key to clear the Reset and Warn flags for both Team 1 and Team 2. Default hot key is unassigned.
Assigns the hot key to clear the game counts, scores, time outs, reset flags and warn flags for both Team 1 and Team 2. Default hot key is a.
Assigns the hot key to reset the timer to 0 regardless of what it is currently timing. Default hot key is r.
Assigns the hot key to start the Shot timer. Default hot key is s.
Assigns the hot key to start the Pass timer. Default hot key is p.
Assigns the hot key to start the Time Out timer. Default hot key is o.
Assigns the hot key to start the Game timer. Default hot key is g.
Assigns the hot key to start the Recall timer. Default hot key is c.
Assigns the hot key to bring up the Select directory for path dialog box. Default hot key is unassigned.
Assigns the hot key to set the Path for the current data files. Default hot key is unassigned.
Assigns the hot key to fetch the current data stored in the data files. Default hot key is unassigned.
Assigns the hot key to Save All the data for the current table to the currently selected path. Default hot key is unassigned.
Assigns the hot key to bring up the Settings window. Default hot key is unassigned.
Click the save button to save any hot key changes made.
Click the cancel button to discard any hot keye changes made.
Click the Restore Defaults button to restore the default hot keys.