Project Structure

Folders

Path To Folder	Purpose
./Scripts	Python modules
./data	Data files for Pit Mopper(ie: Images and Fonts)

Path To File	Purpose
./Pit Mopper.py	Main Python file, run it to play the game
./compile.py	Python Script which compiles program to an EXE
./server.py	Going to be the server for online multiplayer games
./requirements.txt	List of modules required. Simply use `pip install -r requirements.txt` to install them all
./LICENSE.txt	The License for Pit Mopper

Path To File	Purpose
./Scripts/app.py	Defines the `App` class
./Scripts/base_logger.py	Defines the `init_logger` function which initializes the `logging` module
./Scripts/constants.py	Defines lots of constants and variables used by almost all of the files
./Scripts/custom_menubar.py	Has the `CustomMenuBar` class which was taken and edited from SO
./Scripts/functions.py	Defines many functions used by most files
./Scripts/game.py	Has a variety of game classes which are all dataclasses meaning they are used to store data
./Scripts/grid.py	Defines the `ButtonGrid` and `PickleButtonGrid` classes which create a grid of `Squares`, used by some files
./Scripts/load_font.py	Has the `load_font` function for using fonts, only used by `squares.py`, also taken from SO
./Scripts/multiplayer.py	A script that runs Pit Mopper in multiplayer mode
./Scripts/network.py	Has `Network` class which acts as a websocket connection to the server, also has `check_internet` function
./Scripts/single_player.py	A script that runs Pit Mopper in single player mode
./Scripts/squares.py	Defines the `Square` class which represents a single square on the grid of buttons
./Scripts/updater.py	Defines `check_for_updates` function which, well checks for updates and installs them

Path To File	Purpose
./data/fonts/DSEG7ClassicMini-Bold.ttf	A font used by the `Square` class. DSEG Font
./data/images/windows_icon.ico	The logo for Pit Mopper on Windows
./data/images/windows_icon_darkmode.ico	The logo for Pit Mopper in darkmode for windows
./data/images/linux_icon.xbm	The logo for Pit Mopper on Linux
./data/images/linux_icon_darkmode.ico	The logo for Pit Mopper in darkmode for Linux