OBS Scripts

A collection of lightweight, native automation scripts (Lua & Python) designed to enhance stream management, layout control, and production quality in OBS Studio.

This repository hosts independent modules tailored to specific streaming workflows, ensuring minimal overhead and seamless integration.

---

🗂️ Repository Structure

Each automation tool is isolated within its own directory containing its respective logic, assets, and specific documentation.

.
├── .git/                              # Git version control directory
├── .github/                           # GitHub-specific files (e.g., issue templates, workflows)
├── categories/                        # Organized by streaming categories (e.g., gaming, music, IRL)
│   ├── gaming/
│   │   ├── league-of-legends/
│   │   │   ├── lol_map_hider/         # Map visibility automation for League of Legends
│   │   │   │   ├── assets/            # Module-specific screenshots
│   │   │   │   ├── lol_map_hider.lua  # Lua version of the script
│   │   │   │   ├── lol_map_hider.py   # Python version of the script
│   │   │   │   └── README.md          # Module setup guide
│   │   │   └── ...                    # Other League of Legends modules
│   │   └── ...                        # Other gaming modules
│   └── ...                            # Other categories modules
├── .gitattributes                     # Git attributes for file handling
├── .gitignore                         # Git ignore rules
└── README.md                          # Global documentation (This file)

🛠️ General Prerequisites

Important

Python files are not guaranteed to work in all OBS environments due to varying Python support. Please note that these scripts are not fully tested, so keep in mind that unexpected errors may occur.

Tip

While the Python scripts follow the same logic as the Lua versions, Python is occasionally not fully recognized by OBS, which can cause compatibility issues. Therefore, it is highly recommended to use Lua files whenever available; they are natively supported by OBS and work out of the box without requiring any additional configuration.

To run any script from this repository, you must meet the following general environment requirements:

• OBS Studio: Version 30.0 or higher recommended.

• For Lua Scripts (.lua):

  • Lua: (compatible version with your OBS installation, typically Lua 5.1 or 5.2).
  • No external dependencies required; supported natively out of the box by OBS Studio.

• For Python Scripts (.py):

  • Python: (compatible version with your OBS installation, typically 3.10 or 3.11).
  • Python path: configured correctly within OBS (Tools -> Scripts -> Python Settings).

⚙️ General installation

1. Clone or download the repository to your local machine.
2. Open OBS Studio and navigate to Tools -> Scripts.
3. Click the + button to add a new script.
4. Follow the module-specific configuration steps in its dedicated README.md file.

Tip: You can only download a single module if you want, not all the repository.

🤝 Contributing

Contributions to optimize existing scripts or introduce new OBS automations are welcome!

1. Fork the project.
2. Create your feature branch (git checkout -b feature/AmazingAutomation).
3. Commit your changes (git commit -m 'feat: add some AmazingAutomation').
4. Push to the branch (git push origin feat/AmazingAutomation).
5. Open a Pull Request.

Please ensure you follow the existing repository structure and include a detailed README.md for any new module.