andrewdwhite / galaxygenericimporterplugin Goto Github PK

Add unit tests to actions run for releases

Update documentation with directions for updating.

• Optional: To keep existing database copy game_cache and game_cache-times into unzipped new copy
• Delete old installation and replace with new

Create field for pulling names using custom regex

It looks like galaxy wants some of the process left up for it to kill. Leaving everything leaves zombie processes.

Improve obtaining directory change notifications:

• Should include modifications to limit changes to changed locations.
• Should involve cleaning up code from #48

RE:#30 Add normalization for data to galaxy for known "bad" / unaccepted characters.

Determine feasibility to add achievement integration

Add a better mechanism to better determine the program added to galaxy. Potentially use hash of file contents to pull metadata from on online data base. Another potential option is to add an option to throw the file to another program on the device to determine this information. This is linked to #6

Update actions to use the requirements pip file

TODO test that linter workflow works. RE:#13

Determine if there exists a way to generically implement multiple platforms in Galaxy API. There is some code implemented in the multiplatform branch but this method seems to be missing API integrations to facilitate it. https://github.com/AndrewDWhite/GalaxyGenericImporterPlugin/tree/multiplatform

Galaxy does not seem to pick up new names with an existing id determine what is going here

If the gam name has dots like B.A.T., the plugin only return B as a name.

I solve the issue using:
{
"name" : "Amiga",
"execution" : ""D:\Emulation\RetroArch\retroarch.exe" -f -L "D:\Emulation\RetroArch\cores\puae_libretro.dll" "%ROM_RAW%"",
"path_regex" : ["D:\Applications et jeux\Amiga"],
"tags" : ["Amiga"],
"game_name_regex" : ".\\([\(\[].)[.][^\\.]+$",
"game_name_regex_group" : 1,
"system_rom_name_regex_group" : 1,
"filename_regex" : ["[.]lha","*[.]zip"],
"gameShouldBeInstalled" : true,
"hashContent" : false
},

It's an exemple for my Amiga games using Retroarch. It works for other platforms

Currently no information is provided back into the logs on what error the operating system is reporting when starting a program. The thread needs to add logging for errors from this. Noticed in #79

Research galaxy sent data to plugins create full end to end integration test with fake expected sample data.

Use a code linter to improve the code quality of the prototype concept.

Update the configuration code to correctly pull optional configuration options. Including the file which only has the user name in it.

Add configuration option to allow for more tagging of software

Determine if the local galaxy-2.0.db, located in C:\ProgramData\GOG.com\Galaxy\storage , can be used to send less information to galaxy.

• Determine if the time is synced to the database before we have to update the played times to support multiple computers

Look at LastPlayedDates and GameTimes databases for the stored information to update

• Determine if this data is synced soon enough to not have to send as many update messages at startup

Send less owned games updates

Update configuration directory to be an array to support multiple folders for a given system.

Investigate whether or not any of the example sources also need the path updated as well like a few applications needed for the itch plugin. The command I used there was something like the following:
"%windir%\\Sysnative\\cmd.exe /c \"cd /d \""+my_base_path+"\" && \""+my_full_path+"\"\""

Adding in profiling data disables auto fail on build error. Add this back in again.

Debugging page links to gog database may be out of date as the link I tested today no longer returns the expected result. The provided information is correct but research needs to be done to determine the new links or if the page is just currently down.

The version number in the config file, manifest.json , needs to be updated with the build workflow. It looks like the variable that is automatically generated and is human readable is github.run_number .

Also see:
https://github.com/UncleGoogle/galaxy-integration-humblebundle/blob/master/.github/workflows/release.yml

On startup if plug-in does not finish loading within a time limit galaxy forcefully kills it.

Noticed it during listing after loading emulators configuration completed for get local updates.

I click play and nothing happens. I'm trying to use Cemu and Dolphin. I've set up the config file, however nothing happens.

Create an endpoint to enabling data enrichment from endpoints such as igdb to pull more complete data to send to galaxy. This would be useful for example with ps3 hdd backups to automatically determine which game is which based on the release id.

Review and cleanup code following linter suggestions.

Increase code coverage adding additional unit tests

This option would not allow the install of play button to be clickable for a given program. Determine if there is value in only listing programs if they cannot be launched.

Look into feasibility of obtaining directory change notifications to reduce hit in performance against system. This kind of feature would be needed to sustainably support a hashing feature.
https://docs.microsoft.com/en-us/windows/win32/fileio/obtaining-directory-change-notifications

Features such as user_friends exists in the steamcmd.exe . Look into the feasibility of generically implementing a feature to allow the programmatic definition of friends.
https://developer.valvesoftware.com/wiki/Command_Line_Options

Determine if there are any additional github features which the project should integrate. This includes looking at features such as license.

Break apart the code into logical folders.

Look into characters which cause Galaxy to be unable to name a game. While testing it was discovered that some characters like ( and ) will cause Galaxy to be unable to assign a game name without returning an error to the log. Determine what is causing this and if there is some list of undocumented reserved characters which need to be dropped.

Create additional documentation for usage and configuration.

In previous versions to yesterday we previously monitored folders which didn't exist on the system. Determine if we want to monitor them like we previously did.

Determine if any additional existing integration points with Galaxy should be implemented

Determine if it matters that it is possible for a user to define a file to be loaded by multiple entries

Look into the feasibility of implementing a better mechanism to tie applications with multiple executables together. Currently platforms such as Dos and Amazon can have an issue where the program will automatically define multiple executables as either multiple applications in Galaxy of as one with multiple executions available. Look into providing a better option to the user for interfacing with these programs. Suggested to look into seeing if tying the application id to the folder, to ensure it is the same, for these platforms which utilize folders as the root of the application along with any way to provide differentiation between the executables.

Update the code to track play time for launched games

The Follow up workflow is not showing up.

Ensure that build for initial pull request shows up in request for pull.

Look into supporting trophies

Review this more and determine if either it can be re-licensed under this license or if it would have to be rewritten. Then use this as a potential point for integration to allow access to a GUI for configuration and setup.

https://github.com/UncleGoogle/galaxy-integration-humblebundle/blob/ffe063ed3c047053039851256cf23a5343317f2e/src/plugin.py#L295

Determine the issue causing the hashing of file contents to crash script while running when spawned by Galaxy. This ticket will be obsolete if #7 is determined to not need this.

Galaxy will not have all tags for a program if there are multiple instances across different platforms. Here is an example of a program for the vita and PC.

Sustained 100% disk utilization from other processes will cause galaxy to report the plugin as crashed. I am unsure exactly how much and how long you need this to get it to cause the issue. Got the issue to occur by having amazon games and origin to update programs while downloading something at the same time even though they were not to any monitored folders just to a monitored drive.

After refactoring to use another thread for library updates, the code is no longer thread safe and may cause issues where the library is out of date between the two threads. This can cause data to be lost. The code needs to be refactored to pass changes and lock the cache when writes, deletes are preformed or improve the system to be eventually consistent instead of dropping data.

Importing many games at once on initial connection may not import all games. It appears to be on Galaxy's end since the games will show up if you force send the data to it again by deleting the cache and repopulating without disconnecting the plugin.