Iron Alerts

Iron Alerts is a python IMAP listener that allows you to listen to an email client such as Proton Bridge to extract donation information from confirmation emails in order to send it as a custom streamlab alert to use in online livestreams.
Report Bug · Request Feature

Table of Contents

1. Getting Started
   • Prerequisites
   • Installation
2. Contributing
3. License
4. Contact

Getting Started

Follow these steps to set up and start using the Iron Alerts script to seamlessly integrate Iron Phi email notifications with your Streamlabs alerts. Get started by cloning this repo and follow the below steps:

Prerequisites

• Python
• An email that supports IMAP. (Due to GMail's security requirements, additional modifications to this script are required. Proton is the recomended email provider.)
• In your Iron Phi profile settings, ensure emails are set to send as plain text.

Installation

1. Clone the repo

   git clone https://github.com/bwrightgene/ironalerts.git

2. Install Requirements

   pip install -r requirements.txt

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the GPL-3.0 License. See LICENSE.txt for more information.

(back to top)

Contact

Brennan Wright (Iron Phi 1121) - @krittrtv - [email protected]

Project Link: https://github.com/bwrightgene/ironalerts

(back to top)