diff options
author | Marko Zajc <marko@zajc.eu.org> | 2024-03-19 01:45:53 +0100 |
---|---|---|
committer | Marko Zajc <marko@zajc.eu.org> | 2024-03-19 02:21:27 +0100 |
commit | 54cb615a682e1a5a886ec8c93fca8cfe8c1a8bc3 (patch) | |
tree | aa3746a058991d4bfb438390bfb104b130fc940b /README.md |
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 147 |
1 files changed, 147 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..c30755f --- /dev/null +++ b/README.md | |||
@@ -0,0 +1,147 @@ | |||
1 | # gogarchiver-ng | ||
2 | A Java rewrite of [gogarchiver](https://github.com/markozajc/gogarchiver), the GOG.com archival tool written in bash, with many improvements: | ||
3 | |||
4 | * a better, more flexible CLI | ||
5 | * parallel download support | ||
6 | * DLC support | ||
7 | * account library retrieval | ||
8 | * a much improved interface | ||
9 | |||
10 | ## Building | ||
11 | Prerequisites: | ||
12 | |||
13 | * JDK (>= 17) | ||
14 | * Maven (>= 3.2.5) | ||
15 | |||
16 | Run the following: | ||
17 | ``` | ||
18 | $ mvn clean package | ||
19 | ``` | ||
20 | The output runnable JAR will be written to `target/gogarchiver-ng.jar`. There will be another JAR with the version number in that directory - ignore it. | ||
21 | |||
22 | ## Finding the authorization token | ||
23 | 1. Open firefox | ||
24 | 2. Log into GOG.COM | ||
25 | 3. Open developer tools (Ctrl + Shift + Alt) | ||
26 | 4. Navigate to the *Storage* tab | ||
27 | 5. Select *Cookies*, and then *https://www.gog.com/* on the left sidebar | ||
28 | 6. Locate the `gog-al` cookie, and copy its value | ||
29 | |||
30 | The cookie can be passed to gogarchiver-ng directly (via `-k`) or through a file for better security (via `-K`). | ||
31 | |||
32 | ## Available on: | ||
33 | * [https://git.zajc.eu.org/gogarchiver-ng.git/](https://git.zajc.eu.org/gogarchiver-ng.git/) | ||
34 | * [https://github.com/markozajc/gogarchiver-ng/](https://github.com/markozajc/gogarchiver-ng/) | ||
35 | |||
36 | Prebuilt binaries are available at [https://files.zajc.eu.org/builds/gogarchiver-ng/](https://files.zajc.eu.org/builds/gogarchiver-ng/). | ||
37 | |||
38 | <div class="sect1"> | ||
39 | <h2 id="_options">Usage</h2> | ||
40 | <div class="sectionbody"> | ||
41 | <div class="dlist"> | ||
42 | <dl> | ||
43 | <dt class="hdlist1"><strong>-k</strong>, <strong>--token</strong>=<em>TOKEN</em></dt> | ||
44 | <dd> | ||
45 | <p>GOG token, which can be extracted from the gog-al cookie</p> | ||
46 | </dd> | ||
47 | <dt class="hdlist1"><strong>-K</strong>, <strong>--token-file</strong>=<em>PATH</em></dt> | ||
48 | <dd> | ||
49 | <p>read GOG token from a file</p> | ||
50 | </dd> | ||
51 | <dt class="hdlist1"><strong>-o</strong>, <strong>--output</strong>=<em>PATH</em></dt> | ||
52 | <dd> | ||
53 | <p>directory to write downloaded games to</p> | ||
54 | </dd> | ||
55 | <dt class="hdlist1"><strong>-t</strong>, <strong>--threads</strong>=<em>THREADS</em></dt> | ||
56 | <dd> | ||
57 | <p>number of download threads</p> | ||
58 | <div class="literalblock"> | ||
59 | Default: (same as machine's thread count) | ||
60 | </div> | ||
61 | </dd> | ||
62 | <dt class="hdlist1"><strong>-q</strong>, <strong>--quiet</strong></dt> | ||
63 | <dd> | ||
64 | <p>disable progress bars</p> | ||
65 | </dd> | ||
66 | <dt class="hdlist1"><strong>-c</strong>, <strong>--color</strong>=<em>MODE</em></dt> | ||
67 | <dd> | ||
68 | <p>control output color. Supported are auto, on, off</p> | ||
69 | </dd> | ||
70 | <dt class="hdlist1"><strong>-h</strong>, <strong>--help</strong></dt> | ||
71 | <dd> | ||
72 | <p>Show this help message and exit.</p> | ||
73 | </dd> | ||
74 | <dt class="hdlist1"><strong>-V</strong>, <strong>--version</strong></dt> | ||
75 | <dd> | ||
76 | <p>Print version information and exit.</p> | ||
77 | </dd> | ||
78 | </dl> | ||
79 | </div> | ||
80 | </div> | ||
81 | </div> | ||
82 | <div class="sect1"> | ||
83 | <h2 id="_filter_options">Filter options</h2> | ||
84 | <div class="sectionbody"> | ||
85 | <div class="dlist"> | ||
86 | <dl> | ||
87 | <dt class="hdlist1"><strong>--[no-]installers</strong></dt> | ||
88 | <dd> | ||
89 | <p>download installers</p> | ||
90 | <div class="literalblock"> | ||
91 | Default: true | ||
92 | </div> | ||
93 | </dd> | ||
94 | <dt class="hdlist1"><strong>--[no-]patches</strong></dt> | ||
95 | <dd> | ||
96 | <p>download version patches</p> | ||
97 | <div class="literalblock"> | ||
98 | Default: true | ||
99 | </div> | ||
100 | </dd> | ||
101 | <dt class="hdlist1"><strong>--[no-]dlcs</strong></dt> | ||
102 | <dd> | ||
103 | <p>download available DLCs</p> | ||
104 | <div class="literalblock"> | ||
105 | Default: true | ||
106 | </div> | ||
107 | </dd> | ||
108 | <dt class="hdlist1"><strong>-i</strong>, <strong>--include-game</strong>=<em>ID</em>[,<em>ID</em>…​]</dt> | ||
109 | <dd> | ||
110 | <p>only the listed game IDs will be downloaded. Game IDs can be obtained from <a href="https://www.gogdb.org/" class="bare">https://www.gogdb.org/</a></p> | ||
111 | </dd> | ||
112 | <dt class="hdlist1"><strong>-e</strong>, <strong>--exclude-game</strong>=<em>ID</em>[,<em>ID</em>…​]</dt> | ||
113 | <dd> | ||
114 | <p>all games owned by the account except those listed will be downloaded</p> | ||
115 | </dd> | ||
116 | <dt class="hdlist1"><strong>--include-platform</strong>=<em>PLATFORM</em>[,<em>PLATFORM</em>…​]</dt> | ||
117 | <dd> | ||
118 | <p>platforms to download for. Supported are linux, windows, mac</p> | ||
119 | </dd> | ||
120 | <dt class="hdlist1"><strong>--exclude-platform</strong>=<em>PLATFORM</em>[,<em>PLATFORM</em>…​]</dt> | ||
121 | <dd> | ||
122 | <p>platforms to not download for</p> | ||
123 | </dd> | ||
124 | </dl> | ||
125 | </div> | ||
126 | </div> | ||
127 | </div> | ||
128 | <div class="sect1"> | ||
129 | <h2 id="_advanced_options">Advanced options</h2> | ||
130 | <div class="sectionbody"> | ||
131 | <div class="dlist"> | ||
132 | <dl> | ||
133 | <dt class="hdlist1"><strong>-v</strong>, <strong>--verbose</strong></dt> | ||
134 | <dd> | ||
135 | <p>display verbose log messages</p> | ||
136 | </dd> | ||
137 | <dt class="hdlist1"><strong>--[no-]unknown-types</strong></dt> | ||
138 | <dd> | ||
139 | <p>download unknown download types</p> | ||
140 | <div class="literalblock"> | ||
141 | Default: false | ||
142 | </div> | ||
143 | </dd> | ||
144 | </dl> | ||
145 | </div> | ||
146 | </div> | ||
147 | </div> | ||