resolving merge conflicts from pull STOCD#110

Author: Shinga13

.flake8

@@ -0,0 +1,3 @@
+[flake8]
+ignore=E501,F401,E126,W503
+max-line-length = 100

.github/workflows/build.yml

@@ -0,0 +1,52 @@
+name: Build Python Distribution
+
+on: push
+
+jobs:
+  build_release:
+    if: startsWith(github.ref, 'refs/tags/v')
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [windows-latest]
+
+    steps:
+    - uses: actions/checkout@v2
+    - uses: actions/setup-python@v2
+      with:
+        python-version: "3.12"
+    - run: python3 -m pip install virtualenv cx_Freeze
+    - run: python3 -m virtualenv venv
+    - run: .\venv\Scripts\activate.bat
+    - run: pip install .
+    - run: cxfreeze build_exe
+    - uses: actions/upload-artifact@v4
+      with:
+        name: build_release
+        path: build/exe.win*/
+
+  release:
+    if: startsWith(github.ref, 'refs/tags/v')
+    needs: [ build_release ]
+    name: Create release
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+
+    steps:
+      - name: Download
+        uses: actions/download-artifact@v4
+        with:
+          name: build_release
+          path: .
+      - name: Bundle App
+        run: |
+          cd exe.win*
+          zip -r SETS.zip .
+          mv SETS.zip ..
+          cd ..
+      - name: Create release
+        uses: ncipollo/release-action@v1
+        with:
+          artifacts: SETS.zip

.gitignore

@@ -1,155 +1,5 @@
-# Project-specific directories
-cache/
 .config/
 images/
-.vscode/
-
-# Byte-compiled / optimized / DLL files
+..debug/
 __pycache__/
 *.py[cod]
-*$py.class
-
-# C extensions
-*.so
-
-# Distribution / packaging
-.Python
-build/
-develop-eggs/
-dist/
-downloads/
-eggs/
-.eggs/
-lib/
-lib64/
-parts/
-sdist/
-var/
-wheels/
-pip-wheel-metadata/
-share/python-wheels/
-*.egg-info/
-.installed.cfg
-*.egg
-MANIFEST
-
-# PyInstaller
-#  Usually these files are written by a python script from a template
-#  before PyInstaller builds the exe, so as to inject date/other infos into it.
-*.manifest
-*.spec
-
-# Installer logs
-pip-log.txt
-pip-delete-this-directory.txt
-
-# Unit test / coverage reports
-htmlcov/
-.tox/
-.nox/
-.coverage
-.coverage.*
-.cache
-nosetests.xml
-coverage.xml
-*.cover
-*.py,cover
-.hypothesis/
-.pytest_cache/
-
-# Translations
-*.mo
-*.pot
-
-# Django stuff:
-*.log
-local_settings.py
-db.sqlite3
-db.sqlite3-journal
-
-# Flask stuff:
-instance/
-.webassets-cache
-
-# Scrapy stuff:
-.scrapy
-
-# Sphinx documentation
-docs/_build/
-
-# PyBuilder
-target/
-
-# Jupyter Notebook
-.ipynb_checkpoints
-
-# IPython
-profile_default/
-ipython_config.py
-
-# pyenv
-.python-version
-
-# pipenv
-#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
-#   However, in case of collaboration, if having platform-specific dependencies or dependencies
-#   having no cross-platform support, pipenv may install dependencies that don't work, or not
-#   install all needed dependencies.
-#Pipfile.lock
-
-# PEP 582; used by e.g. github.com/David-OConnor/pyflow
-__pypackages__/
-
-# Celery stuff
-celerybeat-schedule
-celerybeat.pid
-
-# SageMath parsed files
-*.sage.py
-
-# Environments
-.env
-.venv
-env/
-venv/
-ENV/
-env.bak/
-venv.bak/
-
-# Spyder project settings
-.spyderproject
-.spyproject
-
-# Rope project settings
-.ropeproject
-
-# mkdocs documentation
-/site
-
-# mypy
-.mypy_cache/
-.dmypy.json
-dmypy.json
-
-# Pyre type checker
-.pyre/
-firststart.py
-GETPYTHON.bat
-readme.txt
-RUN.bat
-RUNNOUPDATE.bat
-SETS_Package_v5.2.exe
-SETUP.bat
-.template.json
-.debug
-test.json
-.config.json
-.state_SETS.json
-main.py.bak
-
-# Pycharm data
-.idea/
-wily-report.html
-.pylintrc
-.pylint_current
-.pylint_current.json

README.md

@@ -1,77 +1,48 @@
 # SETS - STO Equipment and Trait Selector
-A Star Trek Online build tool in Python
-**Website: https://stobuilds.com/apps/sets**
+A Star Trek Online build tool in Python. Please refer to the [website](https://stobuilds.com/apps/sets) for information on how this app is used and included features.
 
 ## Description
-
 Build management and sharing tool for STO.
-Builds can be exported to a PNG file that can be opened by another person using SETS.
-
-## Contributing
-If you find any information or images missing, please check or update the official wiki (https://stowiki.net) -- where SETS gets this information. You can report wiki issues on the Star Trek Online Community Discord Server (https://discord.gg/eApUvTRr5q) in the #wiki-requests channel or on the STOBuilds Discord Server (https://discord.gg/stobuilds) in the #wiki-update-talk channel.
-
-For application-related issues or suggestions, please visit the STOBuilds Discord: https://discord.gg/stobuilds (#sets-support channel)
-
-## Getting Started
-### Application (no installations required)
-*Currently not available*
+Builds can be exported to a PNG or JSON file that can be opened by another person using SETS.
 
-### Script (Windows 8, 10, 11 ONLY)
-For Windows 8, 10, 11 there is the possibility to get `SETS Loader` that contains batch scripts to install the app. Get `SETS Loader` from it's repository: https://github.com/STOCD/SETS_Loader
+## Installation
+### Images library
+All installation methods require an images library containing the game icons. The app will download these automatically, but as this takes a very long time, it is recommended to download the newest compressed image library from the [release](https://github.com/STOCD/releases) page. Once downloaded this has to be decompressed and placed in into the `.config/images` folder.
+```
+SETS
+ +- .config
+ |  `- images
+ |    `- <lots of images>
+ +- SETS.exe / main.py
+ +- ...
+```
 
-### Script (using the git source)
-- View the INSTALLATION.md file for detailed installation information
-- This is not necessary with the application version.
+### Executable for Windows
+Download the zipped app from the [release](https://github.com/STOCD/releases) page. Unzip it into a folder where you want your app to live. To speed up the image downloading process, obtain the images library as detailed above. Double-clicking `SETS.exe` will start the app.
 
-### Running the program (script, not application)
+You can create a desktop shortcut by rightclicking on `SETS.exe` and clicking on "Create shortcut" in the context menu. Then move the created shortcut to your desktop. To create a start menu entry, open the start menu folder by rightclicking on an arbitrary app in your start menu and clicking on "Open file location". Then move the created shortcut to the folder that opened.
 
-Windows:
-> python main.py
 
-Linux/macOS:
-> python3 main.py
-> 
-### Dependencies
-* Python 3.8 or higher
-* Pillow
-* requests-html
-* lxml-html-clean
-* numpy
-* tkmacos (MacOS only)
+### Script (Cross-Platform)
+*The commands below are for Windows. If you want to install the app on Linux, use `python3` instead of `python`. A more comprehensive guide for installing the script version can be found on the [website](https://stobuilds.com/apps/sets/installation).*
 
+First, create a folder to house your app. Open a command prompt and navigate *inside* the created folder.
 
-## Image cache
-The image cache can be over 4,000 files.
+Download the source code. This can be done using `git` or manual download:
+- Manual Download: On the GitHub page of [this repository](https://github.com/STOCD/SETS), click on the green `CODE` button and select "Download ZIP". Save the archive and unpack it so that the files and folders seen on the repository page are *directly* inside your app folder.
+- Git: run `git clone https://github.com/STOCD/SETS.git .`
 
-The majority of this are gear icons and ship images.  Gear icons tend to be very small (under 40MB for them all, included in the packaged images) while ship images can be quite large and are left for automatic download.
-- `CONFIG_DIRECTORY/images/` (automatic) is used to store downloaded images.
-You can find the images archive on the [release page](https://github.com/STOCD/SETS/releases)
+Install dependencies by running `python -m pip install .`.
 
-## Configuration directory
-The configuration directory contains multiple files and folders.
-The configuration directory will automatically be created.
+To speed up the image download process on first start of the app, download the latest image archive from [releases](https://github.com/STOCD/SETS/releases). Create a `.config` folder and unpack the images archive into it. The images should be in `<app_root>\.config\images\`.
 
-### Configuration Files
-- `cache/` (automatic) is used to store downloaded wiki source data
-- `library/` (automatic) is the default open/save location for exports and imports.
-- `library/.template.json` (optional) will be imported when running the app [^2]
-- `library/autosave.json` (automatic) will be used to save changes as you make them
-- `override/` (optional) will be checked for images/files before the standard locations, allowing a user to manually override any item.
-- `.state_SETS.json` (automatic) is used to store settings
-- `.config.json` (optional) is used for manual settings
+*Ubuntu* users might need to install the `libxcb-cursor0` package for this app to work: `sudo apt install libxcb-cursor0`
 
-## Authors
+To run the app, navigate to your apps folder. Then:
+- Windows: Use `python main.py` to start the app.
+- Linux: Use `python3 main.py` to start the app.
 
-* Producer - Mara "Sizer" Morrigan - mara.mos714@gmail.com, Discord: Sizer#3498
-* Programmer - Liraal2
-* Programmer | Linux Testing - Serious Table - Discord: Serious Table#8141
-* Programmer - Stephen Hill - Discord: sukobi#1841
-* Programmer | QA | "girl Friday" - Shinga - Discord: Shinga#9959
-
-## Licence
-
-SETS and its source code is licensed under GPLv3
-
-Star Trek Online and its content is copyright of Cryptic Studios.
+## Contributing
+If you find any information or images missing, please check or update the [official wiki](https://stowiki.net) -- where SETS gets this information. You can report wiki issues on the [Star Trek Online Community Discord Server](https://discord.gg/eApUvTRr5q) in the "#wiki-discussion" channel or on the [STOBuilds Discord Server](https://discord.gg/kxwHxbsqzF) in the "#wiki-update-talk" channel.
 
-[^2]: This is a standard .json file exported from SETS
+For application-related issues or suggestions, please visit the [STOBuilds Discord](https://discord.gg/kxwHxbsqzF) ("#sets-support" channel).