mirror of
https://github.com/Sude-/lgogdownloader.git
synced 2024-11-20 11:49:17 +01:00
64cae133cf
Old path: $XDG_CONFIG_HOME/lgogdownloader/gamename.conf New path: $XDG_CONFIG_HOME/lgogdownloader/gamespecific/gamename.conf
100 lines
4.0 KiB
Plaintext
100 lines
4.0 KiB
Plaintext
[synopsis]
|
|
.B lgogdownloader
|
|
[\fIOPTION\fP]...
|
|
|
|
[description]
|
|
An open-source GOG.com downloader for Linux users which uses the same API as the official GOGDownloader.
|
|
.PP
|
|
LGOGDownloader can download purchased games, query GOG.com to see if game files have changed, as well as downloading extras such as artwork and manuals. It is capable of downloading language-specific installers for games where they exist.
|
|
.PP
|
|
These games are currently offered only for the Microsoft Windows\[rg] and Apple OS X\[rg] operating systems. To play these games under GNU/Linux will require a compatibility layer such as Wine. Usage of such a program is outside the scope of this document.
|
|
|
|
/--update-check/
|
|
.nf
|
|
/--no-installers/
|
|
.fi
|
|
|
|
/Status codes:/
|
|
.nf
|
|
|
|
[blacklist]
|
|
.fi
|
|
Allows user to specify individual files that should not be downloaded or mentioned as orphans.
|
|
.sp 1
|
|
Each line in the file specifies one blacklist expression, except for empty lines and lines starting with #.
|
|
First few characters specify blacklist item type and flags.
|
|
So far, only regular expression (perl variant) are supported, so each line must start with "Rp" characters.
|
|
After a space comes the expression itself. Expressions are matched against file path relative to what was specified as \fI--directory\fP.
|
|
|
|
\fIExample black list\fP
|
|
.br
|
|
# used to store manually downloaded mods/patches/maps/, don't mention it as orphans
|
|
.br
|
|
Rp ^[^/]*/manual/.*
|
|
.br
|
|
# included with every *divinity game, once is enough
|
|
.br
|
|
Rp beyond_divinity/extras/bd_ladymageknight\.zip
|
|
.br
|
|
Rp divinity_2_developers_cut/extras/divinity_2_ladymageknight\.zip
|
|
.sp
|
|
# extra 6GB is A LOT of space if you don't actually plan to mod your game
|
|
.br
|
|
Rp the_witcher_2/extras/the_witcher_2_redkit\.zip
|
|
.br
|
|
Rp the_witcher_2/extras/extras_pack_3_hu_pl_ru_tr_zh_\.zip
|
|
.br
|
|
Rp the_witcher_2/extras/extras_pack_2_fr_it_jp_\.zip
|
|
|
|
[files]
|
|
.fi
|
|
.TP
|
|
\fI$XDG_CONFIG_HOME/lgogdownloader/\fP
|
|
Storage for configuration files and cookies
|
|
.br
|
|
If \fB$XDG_CONFIG_HOME\fP is not set, it will use \fI$HOME/.config/lgogdownloader/\fP.
|
|
|
|
.TP
|
|
\fI$XDG_CACHE_HOME/lgogdownloader/xml/\fP
|
|
Storage for XML files
|
|
.br
|
|
If \fB$XDG_CACHE_HOME\fP is not set, it will use \fI$HOME/.cache/lgogdownloader/xml/\fP.
|
|
|
|
.TP
|
|
\fI$XDG_CONFIG_HOME/lgogdownloader/blacklist.txt\fP
|
|
Allows user to specify individual files that should not be downloaded or mentioned as orphans.
|
|
.br
|
|
It doesn't have to exist, but if it does exist, it must be readable to lgogdownloader.
|
|
|
|
.TP
|
|
\fI$XDG_CONFIG_HOME/lgogdownloader/gamespecific/gamename.conf\fP
|
|
JSON formatted file. Sets game specific settings for \fBgamename\fP.
|
|
.br
|
|
Allowed settings are \fBlanguage\fP, \fBplatform\fP, \fBdlc\fP and \fBignore-dlc-count\fP.
|
|
.br
|
|
The \fBdlc\fP option is limited to disabling DLC for specific game. It can't enable DLC listing/downloading if \fB--no-dlc\fP option is used.
|
|
.br
|
|
Must be in the following format:
|
|
.br
|
|
{
|
|
"language" : <int>,
|
|
"platform" : <int>,
|
|
"dlc" : <bool>,
|
|
"ignore-dlc-count" : <bool>
|
|
.br
|
|
}
|
|
|
|
[priorities]
|
|
For both languages and platforms, the default behavior is to download all enabled ones.
|
|
The \fBlanguage-priority\fB and \fBplatform-priority\fB switches enable a priority-based mode: only the first matching one will be downloaded.
|
|
.PP
|
|
For example, setting \fBlanguage\fB to 5 means both French and English will be downloaded (if available) for all games. Setting \fBlanguage-priority\fB to 4,1 means that the French version (and only that one) will be downloaded if available, and if not, the English version will be downloaded.
|
|
.PP
|
|
You're allowed to "stack" codes in the priority string if needed. If you set \fBlanguage-priority\fB 132,1 it means it'll download both Spanish (128) and French (4) versions if they are available, and the English (1) one only if none of French and Spanish are available.
|
|
.PP
|
|
Ideally the \fBlanguage\fB and \fBplatform\fB settings should match the sum of all enabled codes in the "priority" versions. If they don't, they'll be overrided with a warning.
|
|
|
|
[availability]
|
|
The latest version of this distribution is available from \fIhttps://github.com/Sude-/lgogdownloader\fP
|
|
|