Update v4.4.0 - Update 1

README.md

@@ -40,8 +40,9 @@
 
 ##
 ### Then run `dependt.py` to install the required Dependencies.
-  1. Open the folder containing all the bot's code, and click `dependt.py` or if you are on linux, `python3 dependt.py`
-  2. File will auto run and auto close (windows), On linux it will run it and then will return you back to your command line
+  1. Open the folder containing all the bot's code, and click `win-install.py` or if you are on linux, run `./install.sh`
+      > If you experience issues with `./install.sh`, please run `chmod +x install.sh`.[^1]
+  3. File will auto run and auto close (windows), On linux it will run it and then will return you back to your command line
 
 ##
 ## Run the bot
@@ -57,3 +58,5 @@
 ## Contact for issues
 If you have issues contact joseph_fallen on discord
 
+[^1]: [How to make a .sh script executable](https://askubuntu.com/questions/229589/how-to-make-a-file-e-g-a-sh-script-executable-so-it-can-be-run-from-a-termi)
+

install.sh

@@ -0,0 +1,39 @@
+#!/bin/bash
+
+# Update package list
+echo "Updating package list..."
+sudo apt update
+
+# Install Python3 and pip if not installed
+echo "Checking for Python3 and pip..."
+sudo apt install -y python3 python3-pip
+
+# Install Discord.py
+echo "Installing discord.py..."
+pip3 install discord.py --break-system-packages
+
+# Install MySQL Connector for Python
+echo "Installing mysql-connector-python..."
+pip3 install mysql-connector --break-system-packages
+
+echo "Installing aiohttp"
+pip3 install aiohttp --break-system-packages
+
+echo "Installing pyyaml"
+pip3 install pyyaml --break-system-packages
+
+echo "Installing loguru"
+pip3 install logguru --break-system-packages
+
+echo "Installing matplotlib"
+pip3 install matplotlib
+
+
+echo "If you wish to know about each modual please see the "modules.md" file."
+wait(10)
+
+echo "All moduals installed!"
+
+wait(2)
+# Done
+echo "Setup is complete."

modules.md

@@ -0,0 +1,48 @@
+# Welcome
+Welcome to the modules file, here you can get info about all moduals in the bot, plus have the direct links to them and their documentation.
+Thank you for all of your support in downloading this bot!
+
+## Discord.py
+Discord.py is the main module in this bot. It is what facilitates all inter-discord communication. Such as:
+  1. Status updates with player count
+  2. Player count commands
+  3. All other relevant commands
+
+You can find/access this module at:
++ [Documentation](https://discordpy.readthedocs.io/en/stable/)
++ [Pip page](https://pypi.org/project/discord.py/)
+
+
+## aiohttp
+The aiohttp module facilitates all web/REST api calls, this is a very importaint element in the bots code, it helps and facilitates actions such as:
+1. Providing the info for player count updates
+2. Logging all player count updates
+
+You can find/access this module at:
++ [Documentation](https://docs.aiohttp.org/en/stable/)
++ [Pip page](https://pypi.org/project/aiohttp/)
+
+## pyYAML
+pyYAML is a YAML 1.1 parser with Unicode support, pickle support, a capable extension API, and sensible error messages.
+##### Quick fact
+> YAML is a data serialization format designed for human readability and interaction with scripting languages
+> We use it for our config file
+
+You can find/access this module at:
++ [Documentation](https://pyyaml.org/wiki/PyYAMLDocumentation)
++ [Pip page](https://pypi.org/project/PyYAML/)
+
+## logguru 
+Loguru is a library which aims to bring enjoyable logging in Python. We use it here to make developing for both us and you guys easy and readable
+
+You can find/access this module at:
++ [Documentation](https://loguru.readthedocs.io/en/stable/index.html)
++ [Pip page](https://pypi.org/project/loguru/)
+
+## matplotlib
+Matplotlib is a comprehensive library for creating static, animated, and interactive visualizations in Python.
+
+
+You can find/access this module at:
++ [Documentation](https://matplotlib.org/stable/index.html)
++ [Pip page](https://pypi.org/project/matplotlib/)

win-install.ps1

@@ -0,0 +1,45 @@
+echo "Welcome to the installer to get you going with SCP:SL Bot"
+wait(5)
+echo "Install beginning now"
+
+
+@"%SystemRoot%\System32\WindowsPowerShell\v1.0\powershell.exe" -NoProfile -InputFormat None -ExecutionPolicy Bypass -Command "iex ((New-Object System.Net.WebClient).DownloadString('https://chocolatey.org/install.ps1'))" && SET "PATH=%PATH%;%ALLUSERSPROFILE%\chocolatey\bin"
+
+wait(5)
+
+# Install Discord.py
+echo "Installing discord.py..."
+pip3 install discord.py --break-system-packages
+
+
+wait(2)
+# Install MySQL Connector for Python
+echo "Installing mysql-connector-python..."
+pip3 install mysql-connector --break-system-packages
+
+
+wait(2)
+echo "Installing aiohttp"
+pip3 install aiohttp --break-system-packages
+
+
+wait(2)
+echo "Installing pyyaml"
+pip3 install pyyaml --break-system-packages
+
+
+wait(2)
+echo "Installing loguru"
+pip3 install logguru --break-system-packages
+
+
+wait(2)
+echo "Installing matplotlib"
+pip3 install matplotlib
+
+
+echo "If you wish to know about each modual please see the "modules.md" file."
+wait(10)
+
+wait(2)
+echo "All moduals installed!"