Skip to content

Latest commit

 

History

History
98 lines (69 loc) · 6.07 KB

README.md

File metadata and controls

98 lines (69 loc) · 6.07 KB
Raw

TCMLobbyBBQ - v1.1

A script for Texas Chains Saw Massacre PC players to use to automatically join the queue again after lobby timeouts, network errors, etc.

WARNING!

We've learned the tool has issues if you are not running at 2560x1440 resolution. We're working on it.

Installation

Install the pre-reqs:

  • Install Python. This script was tested on 3.10.11. No idea if it will work on other versions!
  • Install Python pre-reqs by running these commands at a command prompt:
pip install opencv-python
pip install pillow
pip install pyautogui
pip install python-dotenv
pip install requests

Download the TCMLobbyBBQ .zip file

  1. From the main tool page, click Code > Download ZIP.
  2. Extract it to a folder, say C:\users\your-username\Desktop\TCMLobbyBBQ.
  3. Open a command prompt and navigate to that folder - i.e. cd c:\users\your-username\Desktop\TCMLobbyBBQ
  4. From that directory, run python tcm.py
  5. You will be prompted to choose either Family or Victim. Depending on which one you choose, tcm.py will automatically watch the screens of your TCM game and navigate the menus automatically to queue you in the appropriate lobby.

(Optional) Edit tcm.py for max fun!

Take a look through the script and tweak the timeouts and alerts to your liking!

(Optional) Create an .env file

Personally, we like to use Discord Webhooks to alert us when certain actions in TCM happen. Not sure how to configure those? Read this. If you want to do this, create a file called .env in the same directory as tcm.py with a line like this:

WEBHOOK_URL="https://discord.com/api/webhooks/xxx"

Hint: look at the included .env.example file in this repo.

Common questions/comments

What is this?

It is a Python script (tcm.py) for PC players of The Texas Chain Saw Massacre to get into lobby queues more eficiently.

Whoa, stop right there pal! Is this a cheat?

No! It's not a cheat! If you're a fan of the game, you know one or more of the following can happen to you:

  • You wait for several minutes to get placed into a match, but never do.
  • You're waiting for players in a lobby for waaaaaaay too many minutes, only to have the match fail to start.
  • You're having a blast playing the game when suddenly you're kicked out due to ping time problems, "idle" false positives, etc.

OK, so if it's not a cheat, WHAT DOES THIS SCRIPT DO?

This Python script (tcm.py) regularly monitors what's on your TCM game screen before a match, automatically selects the appropriate menus whether you want to play as victim or family, and then sends you notification(s) of your choice once the match actually begins!

How does it work?

The script is powered by PyAutoGUI which, according to its documentation:

PyAutoGUI lets your Python scripts control the mouse and keyboard to automate interactions with other applications. The API is designed to be simple. PyAutoGUI works on Windows, macOS, and Linux, and runs on Python 2 and 3.

Once you launch the script, you will be prompted to choose to play as victim or family. Then, you'll want to fire up TCM (and click into it if you have multiple monitors - so that the game is "active"). At that point, the script will take regular screenshots of your TCM game, compare it to various files in the pics subfolder, and take appropriate actions.

I don't get it. Be more specific.

Sure, once you run tcm.py and choose whether you want to play as victim or family, here is the continous loop of things the script will check/do:

  1. "Are you at the 'Auto Save' screen (/pics/autosave.jpg)?" If so, the script will press E to move you on to the next screen. Then it will pause 5 seconds and press E again to move past the voiceover stuff.

  2. "Are you at the main TCM splash screen (pics/thetexascsm.jpg)?" If so, the script will press E to continue.

  3. "Are you at the main menu (pics/mainmenu.jpg)?" If so, the script will hit Up a bunch of times and then E to continue.

  4. "Are you at the "windmill" screen ready to pick family or victims(pics/windmill.jpg)? If so, the script will press Up a bunch of times to get to the top of the menu, and then Down the appropriate amount of times for either family or victim, then hit Enter.

  5. "Are you in an active lobby (pics/lobby.jpg)? If so, that's awesome! The script will just sleep for a bit.

  6. "Were you in an active lobby and then the time ran out (pics/unabletofindsuitableplayers.jpg)?" The script will press E to get you back in action.

  7. "What character are you?" The script will look in the /pics folder and try to match the character you've been matched with (still working on getting pics of all characters, this will be done for v1.1 of the script) - then alert you about who that character is via Webhook (be sure to set the Webhook in the .env file!)

  8. "OMg did you actually wait in a lobby and then the match ACTUALLY started (pics/matchstart.jpg)? Congrats! You should get a Webhook alert saying your match will begin shortly (again, be sure to set the Webhook in the .env file!)

LOL! This Python code looks like a baby wrote it!

Be gentle. We don't code at all and gave it our best shot, mom.

This script blew up my computer, deleted all my files and made me miss a mortgage payment!

We're not reponsible at all for anything that happens - be it good, bad or indifferent - to your computer as a result of running this code. Correction: if you win the lottery because of this script, we get half.

Something's broken and/or I can help make tcm.py better!

Great! Raise an issue and let's talk about it!