Skip to content

Commit 23ef0c0

Browse files
committed
readme tweaks
1 parent a51a0fc commit 23ef0c0

File tree

1 file changed

+44
-32
lines changed

1 file changed

+44
-32
lines changed

README.md

Lines changed: 44 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -13,38 +13,43 @@ This project is in open beta. It is not completely bulletproof, but it has been
1313
### Installation:
1414
* There is a zip file in the releases directory. Download this.
1515
* Navigate to where GOG stores the steam plugin.
16-
* For windows, this is `%localappdata%\GOG.com\Galaxy\plugins\installed\steam_ca27391f-2675-49b1-92c0-896d43afa4f8`
17-
* For MacOS, this is `~/Library/Application Support/GOG.com/Galaxy/plugins/installed/steam_ca27391f-2675-49b1-92c0-896d43afa4f8`
16+
* Windows:
17+
<br>`%localappdata%\GOG.com\Galaxy\plugins\installed\steam_ca27391f-2675-49b1-92c0-896d43afa4f8`
18+
* MacOS:
19+
<br>`~/Library/Application Support/GOG.com/Galaxy/plugins/installed/steam_ca27391f-2675-49b1-92c0-896d43afa4f8`
1820
* If the file does not exist, create it. If it does, delete everything inside it.
1921
* Extract the zip release so all the contents are in that file.
2022
* Start GOG Galaxy.
2123

2224
### Logging:
23-
We tried to kill as many bugs and test as many behaviors as possible, but we aren't perfect. You may find some case we haven't tested. Please raise an issue here, and in the comment, attach your logs. They can be found here:
24-
* For windows, this is `%programdata%\GOG.com\Galaxy\logs`
25-
* For MacOS, this is `/Users/Shared/GOG.com/Galaxy/Logs`
25+
We tried to kill as many bugs and test as many behaviors as possible, but we aren't perfect.
26+
<br>You may find some case we haven't tested.
27+
<br>Please raise an issue here, and in the comment, attach your logs.
28+
<br>They can be found here:
29+
* Windows:<br>`%programdata%\GOG.com\Galaxy\logs`
30+
* MacOS: <br>`/Users/Shared/GOG.com/Galaxy/Logs`
2631

2732
We typically only need the `steam_<numbers and letters>.log` file.
2833

2934
## Setup (For Developers)
3035
* Download [Python 3.7.9 32-bit][Python379]
3136
* Install it with the defaults
3237
* Create a new virtual env:
33-
- If you only have Python 3.7.9<br/>
38+
- If you only have Python 3.7.9<br>
3439
`python -m venv .venv`
35-
- If you have multiple Python versions installed (assumes you have `py` as well)<br/>
40+
- If you have multiple Python versions installed (assumes you have `py` as well)<br>
3641
`py -3.7 -m venv .venv`
3742
* Activate the virtual env
38-
- Windows, Powershell:<br/>
39-
`.\.venv\Scripts\activate.ps1`
40-
- MacOS, terminal:<br/>
43+
- Windows, Powershell:<br>
44+
`.venv\Scripts\activate`
45+
- MacOS, terminal:<br>
4146
`.venv/Scripts/activate`
42-
* Install the dev dependencies:<br/>
47+
* Install the dev dependencies:<br>
4348
`pip install -r requirements/dev.txt`
4449
* Make your edits
4550
* Update the protobufs (See README_UPDATE_PROTOBUF_FILES.md for more info)
46-
Take notice of the initial diff between the files in `protobuf_files` and `protobuf_files/orig`
47-
Generating the python files is done via:
51+
<br>Take notice of the initial diff between the files in `protobuf_files` and `protobuf_files/orig`
52+
<br>Generating the python files is done via:
4853
`inv GenerateProtobufMessages`
4954
* Build your edits:
5055
`inv build`
@@ -70,48 +75,55 @@ Please do the following:
7075
<br> If using Windows, make sure you have enabled the setting that `adds Python to the PATH environmental variable`.
7176
<br> These should be the default settings, but make sure anyway.
7277
* Create a new virtual env:
73-
- If you only have python 3.7.9<br/>
78+
- If you only have python 3.7.9<br>
7479
`python -m venv .venv`
75-
- IF you have multiple python versions installed (assumes you have `py` as well)<br/>
80+
- IF you have multiple python versions installed (assumes you have `py` as well)<br>
7681
`py -3.7 -m venv .venv`
7782
* Activate the virtual env
78-
- Windows, Powershell:<br/>
79-
`.\.venv\Scripts\activate.ps1`
80-
- MacOS, terminal:<br/>
81-
`.venv/Scripts/activate.sh`
82-
* Use Pip to get the python tools we need to install the plugin. These will only be applied to the venv you created earlier:<br/>
83+
- Windows, Powershell:<br>
84+
`.venv\Scripts\activate`
85+
- MacOS, terminal:<br>
86+
`.venv/Scripts/activate`
87+
* Use Pip to get the python tools we need to install the plugin.
88+
<br>These will only be applied to the `.venv` virtual environment you created earlier:<br>
8389
`pip install -r requirements/install.txt`
84-
* Install the plugin. It should work if you have deleted the original plugin, but will patch it if it is there.<br/>
90+
* Install the plugin. It should work if you have deleted the original plugin, but will patch it if it is there.<br>
8591
`inv install`
8692

87-
### Installation (non-dev, Tl;Dr):
93+
### Installation (non-dev, TL;DR):
8894

8995
<b>Windows (Powershell recommended)</b>
9096
```
91-
echo You must have installed python 3.7.9 (32 bit). If not, the rest of this won't work.
97+
@echo You must have installed python 3.7.9 (32 bit). If not, the rest of this won't work.
9298
py.exe -3.7 -m venv .venv
93-
echo if the previous command did not work, you do not have py installed or py is not in your PATH. If you only have python 3.7.9, run the next command. If it worked, skip the next command.
99+
@echo If the previous command did not work, you do not have py installed or py is not in your PATH.
100+
@echo If you only have python 3.7.9, run the next command.
101+
@echo If it worked, skip the next command.
94102
python.exe -m venv .venv
95-
echo virtual environment is installed. on to the next step.
96-
.\.venv\Scripts\activate.ps1
103+
@echo virtual environment is installed. on to the next step.
104+
.venv\Scripts\activate
97105
pip install -r requirements/install.txt
98106
inv install
99107
```
100108

101109
<b>MacOS</b> (assumes your shell is bash, which is the default. if you are good enough to change that, you can figure out how to run these)
102110
```
103-
echo I have installed python 3.7.9 (MacOS). If not, the rest of this won't work.
111+
echo You must have installed python 3.7.9 (MacOS). If not, the rest of this won't work.
104112
py -3.7 -m venv .venv
105-
echo if the previous command did not work, you do not have py installed or py is not in your PATH. If you only have python 3.7.9, run the next command. If it worked, skip the next command.
113+
echo If the previous command did not work, you do not have py installed or py is not in your PATH.
114+
echo If you only have python 3.7.9, run the next command.
115+
echo If it worked, skip the next command.
106116
python -m venv .venv
107117
echo virtual environment is installed. on to the next step.
108-
./.venv/Scripts/activate.sh
118+
.venv/Scripts/activate
109119
pip install -r requirements/install.txt
110120
inv install
111121
```
112122

113123
### Install Error fixes:
114-
If `inv install` throws a bunch of errors, make sure you have the proper python venv set up. It should complain about `getargspec`. If this happens, you created the wrong virtual environment. You can either delete .venv and reinstall it, or create a new virtual environment with a different name and use that. make sure you use `py -3.7` when creating your venv. If you don't have py, get it. You can specify the full path to python 3.7 instead if you want, but that's harder to do and harder to explain here.
124+
If `inv install` throws a bunch of errors, make sure you have the proper python venv set up. It should complain about `getargspec`. If this happens, you created the wrong virtual environment. You can either delete the `.venv` folder and reinstall it, or create a new virtual environment with a different name and use that.
125+
126+
Make sure you use `py -3.7` when creating your venv. If you don't have `py`, get it. You can specify the full path to python 3.7 instead if you want, but that's harder to do and harder to explain here.
115127

116128
## Why this fork?
117129

@@ -122,10 +134,10 @@ Well, without being too complicated, Steam changed how they do authentication. W
122134
### Current Version:
123135
This is a fork of https://github.com/FriendsOfGalaxy/galaxy-integration-steam
124136

125-
The new Authorization flow implementation is heavily influenced by SteamKit. https://github.com/SteamRE/SteamKit<br/>
137+
The new Authorization flow implementation is heavily influenced by SteamKit. https://github.com/SteamRE/SteamKit<br>
126138
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.
127139

128-
Some work was influenced by ValvePython. https://github.com/ValvePython/steam<br/>
140+
Some work was influenced by ValvePython. https://github.com/ValvePython/steam<br>
129141
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.
130142

131143
### The names of individual developers will appear here, soon(ish). Any thanks can be directed there

0 commit comments

Comments
 (0)