Merge pull request #113 from AndrewDWhite/dev

Documentation update to better provide some clarification on updating plugin installation process.

Author: AndrewDWhite

.github/workflows/lint.yml

@@ -1,20 +1,36 @@
 name: Lint
 
 on:
-  # Trigger the workflow on push or pull request,
-  # but only for the main branch
+  # Trigger the workflow on pull request,
   pull_request:
-    branches:
-      - main
+    # The branches below must be to the branches below
+    branches: [ master ]
+    types:
+      - opened
+      - synchronize
+      - reopened
+
+permissions:
+    contents: write
+    checks: write
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event_name == 'pull_request' && github.head_ref || github.ref }}
+  cancel-in-progress: true
 
 jobs:
   run-linters:
     name: Run linters
     runs-on: windows-latest
-
+    
     steps:
       - name: Check out Git repository
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
+        with:
+          #repository: ${{ github.event.pull_request.head.repo.full_name }}
+          #ref: ${{ github.event.pull_request.head.ref }}
+          ref: ${{ github.event.pull_request.head.sha }}
+          #repo_token: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Set up Python
         uses: actions/setup-python@v2
@@ -23,7 +39,7 @@ jobs:
           architecture: 'x86' 
 
       - name: Install dependencies
-        run: |
+        run: | 
           py  -3.7-32 -m pip install --upgrade pip
           py  -3.7-32 -m pip install -r requirements/requirements_dev.txt
           py  -3.7-32 -m pip install -r requirements/requirements_dev.txt --target ./src/
@@ -33,4 +49,5 @@ jobs:
         uses: wearerequired/lint-action@v2
         with:
           black: true
-          flake8: true
+          flake8: true
+          

.github/workflows/pythonpackage.yml

@@ -6,6 +6,11 @@ on:
       - completed
   push:
     branches: [ master ]
+    
+  pull_request:
+    branches: [ master, dev ]
+    types:
+      - synchronize
 
 jobs:
   build:

.github/workflows/updatereleaseversion.yml

@@ -2,6 +2,9 @@ name: Update release version
 on:
   pull_request:
     branches: [ master ]
+    types:
+      - opened
+      - reopened
 
 env:
   GITHUB_TOKEN: ${{ github.token }}

README.md

@@ -5,19 +5,20 @@ Plug-in for GOG Galaxy supporting programmatic importation of multiple platform
 
 ## Known issues
 - Upon galaxy update, the plugin's games may be determined to be unsupported. To resolve this for the current update as of 2020-06-15, disconnect the plugin and then reconnect it again. Contrary to galaxy's messages, your game data including play times will be retained upon reconnecting as they are also cached by the plugin.
-- To preserve game data between updates ensure to copy the game_cache and game_cache-times files to the updated installation.
-- To preserve configuration between versions ensure to copy the systems.json file to the updated installation.
 - If you want to allow for metadata to be stripped away between dots, like previous versions, you would add `([.].*)*` before the extension; for example gba would look like `.*[\\\\](.+?)([ ]*[\\(\\[].*[\\)\\]])*([.].*)*[.]gba` for it's regex. This expression will break games with dots in their name. You can look at the history of the configuration for some [examples](https://github.com/AndrewDWhite/GalaxyGenericImporterPlugin/blob/01ed3c6976e6cd17e805387fd0a60a5e48918973/emulators.json).
-- Unknown game issues where galaxy refuses a name you provided to it or refuses to update, can sometimes be fixed by changing the username in config.cfg .
-- Galaxy will place all programs under the same platform. Grouping by tags is a decent substitute so ensure to use useful ones. If you only intend to use one platform, you can also update the config.cfg file for that platform.
+- Unknown game issues where galaxy refuses a name you provided to it or refuses to update, can sometimes be fixed by changing the username in config.cfg , but this is generally controlled by galaxy itself and requires working with GoG to update their database.
+- Galaxy will place all programs under the same platform. Grouping by tags is a decent substitute, so ensure to use useful ones. If you only intend to use one platform, you can also update the config.cfg and manifest.json files to reflect that platform instead of the more generic one.
 - To force the plug-in to re-send every program to galaxy again, useful after updating the configuration manually, remove the caches, game_cache and game_cache-times , and either completely exit and restart galaxy or disable and then re-enable the plug-in.
 - If you own a lot of games, Galaxy may incorrectly report that the plug-in has crashed and force kill it for processing too long. You can try to optimize your regular expressions to allow it to execute quickly enough for it to not hit the maximum processing time. You can also try setting the logging level to info.
 
 ## Installation
-The plug-in will need to be placed in `%localappdata%\GOG.com\Galaxy\plugins\installed\` as `importer_97543122-7785-4444-2254-711233556699` . The easiest version to install is the [latest version](https://github.com/AndrewDWhite/GalaxyGenericImporterPlugin/releases/latest) under releases with all of the libraries pre installed and can be unzipped into the installation directory. The a [Youtube video]( https://www.youtube.com/watch?v=FCrHWRy0fOs) showing installation using default directories for software.
+Ensure that galaxy is completely exited, including from the system tray, before you install the plugin. The plug-in will need to be placed in `%localappdata%\GOG.com\Galaxy\plugins\installed\` as `importer_97543122-7785-4444-2254-711233556699` . The easiest version to install is the [latest version](https://github.com/AndrewDWhite/GalaxyGenericImporterPlugin/releases/latest) under releases with all of the libraries pre installed and can be unzipped into the installation directory. This [Youtube video]( https://www.youtube.com/watch?v=FCrHWRy0fOs) shows installation using default directories for the plugin software.
 
 <img alt="installation directory with plugins installed" src="https://user-images.githubusercontent.com/972757/119213521-981b1980-ba8d-11eb-9a13-e8a8a2438c14.png">
 
+###Updating
+If you are updating from a previous version and you wish to keep your game data, ensure that you copy game_cache and game_cache-times files to the updated installation. If you have made any configuration changes that you wish to preserve, ensure to copy the systems.json and config.cfg files to the updated installation. Once you have finished updating the unzipped folder with these old files make sure to completely remove the existing files from the plugin directory before moving the newly uncompressed version into the plugins folder and restarting galaxy.
+
 ## Default directories
 If the configuration is not changed to reflect your system, then the following is used by default. Your personal `documents\games\` folder will by default be used to house the folders for your systems which will be something like `C:\Users\andyn\Documents\Games\Dreamcast` depending on your user name. See the PSP example for how to have multiple emulators for the same system for different folders and kinds of images.
 

src/manifest.json

@@ -2,7 +2,7 @@
   "name": "importer",
   "platform": "test",
   "guid": "97543122-7785-4444-2254-711233556699",
-  "version": "0.18-baf824762c5d5676b2fe6e11912cb7b0843023af",
+  "version": "0.27-9656a9f13df68f1e94ce2677f0de41b1d6739920",
   "description": "Plugin for GOG Galaxy supporting programmatic importation of multiplatform game libraries. Allows for the generic definition of files to be added using user definable regular expressions.",
   "author": "Andrew David White",
   "email": "972757+AndrewDWhite@users.noreply.github.com",