Suggested install guide issues/fixes

[user23498723452]

Here are some suggested fixes:

• I'd recommend specifically mentioning installing Python 3.11 to streamline things for folks.
• I also suggest saying to enable the "Add python.exe to Path" option on the install page AND use the 'Install Now' option.
• On Step 4, the slashes need to be changed to backslashes, so when folks copy/paste it works on Windows.
• On Step 7 the exe is misnamed. It's 'smirnyboot9001.exe'
• On Steps 12 and 13 - I had another user who couldn't use the IPv4 address and it had to be changed to "localhost" to work for them. Probably caused by the IPv6 preference. I'd suggest changing that. So it matches the sample config.

I have no idea if this version of the updated readme will display correctly here:

smirnybot9001

A twitch chatbot for displaying LEGO sets, minifigs and parts on an HTML overlay

Installation - Windows

1. Download and Install Python (3.11 is currently recommended) from here -> https://www.python.org/downloads/
2. Open a "command prompt" window from the start menu search.
3. In this window, browse to a directory where you wish to install the bot inside of. (google how to use Command Prompt).
   • For sake of this guide, we will be using "C:\Users\YourUserName\"
   • The important thing is that you know where this is located as you will need to edit files in this location, and keeping backups of them may be helpful for you.
4. Using Command Prompt, create the venv using this syntax: python -m venv VENVDIR where VENVDIR can be any text you want. e.g. C:\Users\YourUserName\>python -m venv Smirny_Venv
5. Activate the venv using this syntax: VENVDIR\Scripts\activate.bat e.g. C:\Users\YourUserName\Smirny_Venv\Scripts>activate.bat
6. Install the SmirnyBot into the venv python -m pip install smirnybot9001 e.g. C:\Users\YourUserName\Smirny_Venv\Scripts>python -m pip install smirnybot9001
7. Check that the Bot executables are installed in VENVDIR/Scripts smirnyboot9001.exe overlay.exe chatbot.exe
8. Run smirnyboot9001.exe --help and note the default location of the config file (Usually HOMEDIR\smirnybot9001.conf) e.g. C:\Users\YourUserName\Smirny_Venv\Scripts>smirnyboot9001.exe -h
9. Copy the sample config file from VENVDIR\Lib\site-packages\smirnybot9001\data\sample.conf to the location noted above (from running smirnyboot.exe --help)
10. Create a token for your chatbot twitch user (we recommend using a different user than your personal one) by visiting: https://twitchtokengenerator.com/
11. Configure your newly created token and your channel name (Usually your personal username) in the config file leaving double quotation marks in place
12. Start the bot and overlay using the smirnyboot9001.exe executable.
13. (Optional) For advanced control, I'd recomend making a batch file (anyfilename.bat) anywhere on your computer that has content mimicing the following. You will need to place your own file paths in here to the exe and your config file
    • "C:\Users\YourUserName\Scripts\smirnyboot9001.exe" -c "C:\Users\YourUserName\smirnybot9001.conf"
    • Make sure to enclose the two file paths with double quotes as here.
    • Save this file, and then simply double click this file to run the bot. Again, it can be placed anywhere on your computer.
14. Browse to http://localhost:4711 using any browser to ensure that the overlay is running
15. Create a Browser Source in OBS and set the URL to: http://localhost:4711. Make sure the "Control audio via OBS option is set"
16. Test the bot! Enter !set 10228 in your chat and see if the overlay displays the wanted set.