Dealing with getting the proto files properly parsed and built so the…

… plugin works from task.py. Not finished; switching gears to localization so i don't go insane.

LICENSE

@@ -1,7 +1,9 @@
 
 MIT License
 
-Copyright (c) 2017-2023, Hiroyuki Takagi, FriendsOfGalaxy, Slo, Andrew Baumher, TheSentry, et.al.
+Copyright (c) 2021-2023, FriendsOfGalaxy, Slo, Andrew Baumher, TheSentry, Thibmo et.al.
+Portions of this code Copyright (c) 2015-2023, Rossen Georgiev <rossen@rgp.io>
+Portions of this code Copyright (c) 2017-2023, Hiroyuki Takagi
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

README.md

@@ -43,42 +43,24 @@ This is a fork of the repository from FriendsOfGalaxy, intended to continue deve
 
 If the latest version available on Github is newer than the version specified in the `manifest.json` file in the custom build, Galaxy will download the newer version and replace the files. To prevent this from happening, you can manually set the version in `manifest.json` to a significantly higher value (e.g. `9.9`).
 
-## Configuration of the backend operation mode
+## Why this fork?
 
-The plugin supports different data collectors, called `backends`.
+Well, without being too complicated, Steam changed how they do authentication. We used to be able to use one call and magically get a lot of info we needed. But, if we're being honest, it was a little insecure, and it easy. While we were using it for legitimate purposes, not everyone else was, and one of Valve's greatest deterrence to botting or DOS attacks (etc) is making things difficult. The new workflow uses a significant back-and-forth between a Steam Server and ourselves, closely resembling a common web form of authentication called OAuth2. This meant a lot of under-the-hood changes. 
 
-Currently supported `backends` are:
-1. `Steam Network`
-    - uses internal Steam protocols 
-    - supports library, game times, achievements, importing tags, friends presence
-2. `Public Profiles`
-    - works without providing user credentials
-    - requires steamcommunity.com user's profile to be set as public with access at least for games library
-    - supports library, game times, achievements, importing tags
-
-NOTE: Data imported by different `backends` may differ due to both Steam side inconsistencies and limitations of specific `backend` implementation.
-
-NOTE: interaction with local games and local Steam client is the same for all `backends`.
-
-The behavior is configurable using a `config file`.
-
-### Config file location
-
-- Windows:
-`%localappdata%\GOG.com\Galaxy\plugins\installed\steam_plugin_config.ini`
+## Credits
 
-- MacOS:
-`~/Library/Application Support/GOG.com/Galaxy/plugins/installed/steam_plugin_config.ini`
+### Current Version:
+This is a fork of https://github.com/FriendsOfGalaxy/galaxy-integration-steam
 
-### Default behavior
+The new Authorization flow implementation is heavily influenced by SteamKit. https://github.com/SteamRE/SteamKit<br/>
+While we have not utilized their source code, they have implemented the new authentication workflow before we did, and we used their knowledge of how to do so in order to implement it ourselves. If you are doing anything steam related in C#, you should check them out; their project has far more features than our own.
 
-Initial `backend` (with the login window) is set to use `Steam Network` and switches to `Public Profiles` automatically when stored token become invalid (for the main reason see #74).
+Some work was influenced by ValvePython. https://github.com/ValvePython/steam<br/>
+Our projects do the same thing, but use different methods (we use asyncio, they use gevent, for example). Both projects were working on the new Auth Flow simultaneously, with little collaboration between us. That said, their scope is much larger than our own and lets you do a lot more things. If you are looking for a python means of implementing a steam network authentication, you should use their work instead.
 
-## Credits
-
-This is a fork of https://github.com/FriendsOfGalaxy/galaxy-integration-steam
+### Original Version:
 
-Based on work and research done by others:
+Original Plugin was based on work and research done by others:
 * https://github.com/prncc/steam-scraper
 * https://github.com/rhaarm/steam-scraper
 * https://github.com/mulhod/steam_reviews

galaxy-integration-steam.pyproj

@@ -23,11 +23,11 @@
     <Content Include=".gitignore" />
     <Content Include="current_version.json" />
     <Content Include="galaxy-integration-steam.pyproj" />
+    <Content Include="LICENSE" />
+    <Content Include="protobuf_files\protobuf_list.txt" />
     <Content Include="pytest.ini" />
     <Content Include="README.md" />
-    <Content Include="README_UPDATE_PROTOBUF_FILES.md" />
-    <Content Include="requirements\app.txt" />
-    <Content Include="requirements\dev.txt" />
+    <Content Include="protobuf_files\README_UPDATE_PROTOBUF_FILES.md" />
     <Content Include="src\commonWeb\css\common.css" />
     <Content Include="src\commonWeb\fonts\LatoWeb\LatoWeb-Light.ttf" />
     <Content Include="src\commonWeb\fonts\LatoWeb\LatoWeb-Regular.ttf" />
@@ -109,6 +109,7 @@
     <Compile Include="src\uri_scheme_handler.py" />
     <Compile Include="src\user_profile.py" />
     <Compile Include="src\version.py" />
+    <Compile Include="tasks.py" />
     <Compile Include="tests\async_mock.py" />
     <Compile Include="tests\conftest.py" />
     <Compile Include="tests\tests_public_profiles\conftest.py" />
@@ -147,7 +148,7 @@
     <Compile Include="tests\test_user_profile_checker.py" />
   </ItemGroup>
   <ItemGroup>
-    <Folder Include="requirements" />
+    <Folder Include="protobuf_files\" />
     <Folder Include="src" />
     <Folder Include="src\commonWeb\" />
     <Folder Include="src\commonWeb\css" />

protobuf_files/README_UPDATE_PROTOBUF_FILES.md

@@ -0,0 +1,26 @@
+# Obtaining procedure:
+
+1. Ensure protobuf_files exists in the main directory. This file should be in this location. 
+2. (Optional) Backup any existing `.proto` files. There may have been breaking changes, and it is much easier to compare .proto files instead of their compiled versions. 
+3. From the main directory, execute `inv pull_protobuf_files` it will dump all of the necessary proto files here. 
+
+
+# Updating procedure
+
+1. (Optional) Copy all existing files in `src/steam_network/protocol/messages/` to a backup directory. If you backed up the proto files in the obtain procedure, you may ignore this step. otherwise, they may be useful determining if any changes have occured. 
+2. Make sure that your virtual environment has the `protobuf` library installed. If not then install it with the
+version in the `requirements/app.txt` file.
+3. Make sure your virtual environment has `invoke` installed. if not, install the version in `requirements/app.txt`
+4. Make sure you have `protoc` installed. It should come with `protobuf`, but may not. 
+5. To generate/update python files in `src/steam_network/protocol/messages/`
+from main directory, run command: `inv generate-protobuf-messages`
+6. If you received a warning log in the console that some of the messages already exist, check that the mentioned file
+is not obsolete.
+7. Check imports in `steam_network/protocol/protobuf_client.py`. Some messages could have moved or been renamed.
+8. Build the plugin and check that it works, especially features which may be affected by changes in their protobuf
+messages.
+
+## Sources
+
+* <https://github.com/steamdatabase/protobufs>
+* <https://github.com/ValvePython/steam>