Getting started

This might look like a lot, but it is extremely detailed.

1. Pick one of the methods which can be found on the home page, both are going to get downloaded but method 2 requires 1 extra setup process.

2. Download by right-clicking this link and save as. Place in a folder in which you would like to keep the project.

3. if you are going to use the .exe, skip to step 8 (not recommended). Else, go ahead and install a supported python version. For example Python 3.11.1. Would not recommend using old versions of python, but if you have one installed feel free to try. Make sure to check automatic path variables during install.

4. Open up your console/cmd and type python --version, make sure that it outputs the right version.

5. Run python -m pip install --upgrade pip (do not change pip even though it was wrong in the last step) to run an update.

6. I would recommend using something like virtualenv (for a python environment) but this is no requirement
   Install virtualenv: python -m pip install virtualenv
   Create virtualenv: virtualenv LSE (run inside of the LSE project folder)
   Enable virtualenv (windows, cmd): LSE\Scripts\activate.bat
   Enable virtualenv (windows, powershell): LSE\Scripts\activate.ps1

7. Open up your console/cmd inside of the downloaded project, using dir *.txt should output "requirements.txt".
   Make sure to enable your environment if you use one
   Rightclick the following link and hit save as. Place the file right next to the downloaded Python file.
   Run python -m pip install -r requirements.txt in a console, command prompt/CMD, or similar. Make sure the current directory is the same as the text file. Wait for the packages to install.

8. Download the required files and place them in the same folder (right-click each and save as):
   Download this python file
   Download this Windows executable if you wish to use it

9. Run the Python file by python LocalStreamElements.py
   or the executable for Windows by double-clicking it

10. Should say that an update is required. Follow the instructions (hit y then enter).

11. Wait for LSE to start, it should type out a website address. Something like http://localhost:80 (or an IP like 192.168.1.15 instead of localhost depending on the operative system). Write it in your browser or run website.html which can be found next to the .exe and .py.

12. Scroll down to setup and write down all Twitch and StreamElements related credentials required to launch all services. After typing and hitting save for each box hit restart on Twitch and StreamElements. Should see something like [Chat] Connected to twitch chat USERNAME and [StreamElements] Authenticated! if all credentials are correct.

You are as well able to open up that window on any other device. To do so, open up your console/cmd and type ipconfig (for windows), find your IPv4. This IP is what you have to write in on your other devices browser, for example (192.168.1.7). You are as well required to write the port if you swapped from the default 80, like this: 192.168.1.7:PORT (192.168.1.7:5500).

Feel free to join my discord and send me a Discord DM (Yazaar#1779) if you have any questions, do as well look through the rest of this wiki :)