search

nyash-qq / galaxy-plugin-twitch

Twitch python plugin for GOG Galaxy 2.0
GNU General Public License v3.0
135 stars 6 forks source link

Error in installation instructions? #33

Open Catalack opened 4 years ago

Catalack commented 4 years ago

I think I found an error in your installation instructions. Correcting it might help other users.

The instructions say:

  1. Download latest release of the plugin for your platform.
  2. Create plugin folder (if it does not exists yet): -Windows: %LOCALAPPDATA%\GOG.com\Galaxy\plugins\installed\twitch_8b831aed-dd5f-c0c5-c843-41f9751f67a2 -MacOS: ${HOME}/Library/Application Support/GOG.com/Galaxy/plugins/installed/twitch_8b831aed-dd5f-c0c5-c843-41f9751f67a2
  3. Disconnect Twitch plugin if it's already running, or shutdown the GLX
  4. Unpack (and replace) plugin archive to the plugin folder created in 3.
  5. Re-connect(or re-start) the GLX

I did that (for Windows), and Twitch did not appear in Galaxy's list of integrations.

I found Issue #18 (https://github.com/nyash-qq/galaxy-plugin-twitch/issues/18) which has the same problem with no solution.

I then found a post on gog.com (at https://www.gog.com/forum/general_beta_gog_galaxy_2.0/twitch_games_integration_there_is_a_date/?search=twitch) saying:

To install the Twitch one, download it from here ( https://github.com/nyash-qq/galaxy-plugin-twitch/releases ) and extract the files contained inside of twitch_8b831aed-dd5f-c0c5-c843-41f9751f67a2_v0.4_win32.zip into C:\Program Files (x86)\GOG Galaxy\plugins\Twitch

I did that, and it worked. So why does your readme say to extract the archive to %LOCALAPPDATA%\GOG.com\Galaxy\plugins\installed\twitch_8b831aed-dd5f-c0c5-c843-41f9751f67a2 and not %LOCALAPPDATA%\GOG Galaxy\plugins\Twitch ? Is that what instruction step number 4 means when it's referring to "the plugin folder created in 3"? Did you skip a step? Because 3 does not say anything about creating a folder.

Your response on Issue #18 also does not seem to explain this properly.

Anyways, even if you don't respond to this, I hope this issue post helps other people figure out how to install the plugin. Thanks for the plugin, it makes GOG Galaxy a lot more useful for me.

Rall3n commented 4 years ago

Seems like there is some kind of problem on your end.

Based on official documentation of the galaxy-integrations-python-api repo, the default location on windows for plugins to be installed to is %localappdata%\GOG.com\Galaxy\plugins\installed.
I even tried it myself with a plugin I don´t use. The plugin could not be found in the /plugins directory, but as intended in the /plugins/installed directory.

But you are right that there is an error in the readme. The step mentioned in step 4 should be step 2.

Catalack commented 4 years ago

Hmm, I for sure don't understand what's going on here. Perhaps it has something to do with the fact that my folder for the program is %localappdata%/GOG Galaxy/, not /GOG.com/Galaxy/, and that's also what the poster Franubis wrote in the gog.com forum post I linked. I forgot to mention that in the first post. So when I first tried it, I didn't put the /twitch_8b831aed-dd5f-c0c5-c843-41f9751f67a2/ folder in an empty GOG.com/Galaxy/plugins/installed/ directory, I put it in /GOG Galaxy/plugins/installed/. I don't know why my Galaxy folder has a different name, and I don't think I would have manually changed it.

ThePlatinumGhost commented 3 years ago

Thanks for the solution I had the same "problem" with that the folder for me was also %localappdata%\GOG Galaxy\plugins\ instead of %localappdata%\GOG.com\Galaxy\plugins\installed and after, I created the \Twitch folder I think that in the INSTALLATION Guide on readme should also include this path for those who don't have the other path