-
-
Notifications
You must be signed in to change notification settings - Fork 639
Expand file tree
/
Copy pathlibrary.ts
More file actions
954 lines (860 loc) · 26.8 KB
/
Copy pathlibrary.ts
File metadata and controls
954 lines (860 loc) · 26.8 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
import { existsSync, mkdirSync, readFileSync, readdirSync } from 'graceful-fs'
import {
GameInfo,
InstalledInfo,
CallRunnerOptions,
ExecResult,
InstallPlatform,
LaunchOption
} from 'common/types'
import {
InstalledJsonMetadata,
GameMetadata,
LegendaryInstallInfo,
LegendaryInstallPlatform,
ResponseDataLegendaryAPI,
SelectiveDownload,
GameOverride
} from 'common/types/legendary'
import { LegendaryUser } from './user'
import {
formatEpicStoreUrl,
getLegendaryBin,
isEpicServiceOffline,
getFileSize,
axiosClient
} from '../../utils'
import {
logDebug,
logError,
logInfo,
LogPrefix,
logWarning
} from 'backend/logger'
import {
gamesOverrideStore,
installStore,
libraryStore
} from './electronStores'
import { callRunner } from '../../launcher'
import { dirname, join } from 'path'
import { isOnline } from 'backend/online_monitor'
import { LegendaryCommand } from './commands'
import { LegendaryAppName, LegendaryPlatform } from './commands/base'
import { Path } from 'backend/schemas'
import shlex from 'shlex'
import thirdParty from './thirdParty'
import { Entries } from 'type-fest'
import { runLegendaryCommandStub } from './e2eMock'
import { legendaryConfigPath, legendaryMetadata } from './constants'
import { isWindows } from 'backend/constants/environment'
import { LibraryManager } from 'common/types/game_manager'
const fallBackImage = 'fallback'
const allGames: Set<string> = new Set()
let installedGames: Map<string, InstalledJsonMetadata> = new Map()
const library: Map<string, GameInfo> = new Map()
export default class LegendaryLibraryManager implements LibraryManager {
async init() {
this.loadGamesInAccount()
this.refreshInstalled()
}
/**
* Loads all of the user's games into `allGames`
*/
loadGamesInAccount() {
if (!existsSync(legendaryMetadata)) {
return
}
readdirSync(legendaryMetadata).forEach((filename) => {
// This shouldn't ever happen, but just in case
if (!filename.endsWith('.json')) {
return
}
const appName = filename.split('.').slice(0, -1).join('.')
allGames.add(appName)
})
}
/**
* Refresh games in the user's library.
*/
private async refreshLegendary(): Promise<ExecResult> {
logInfo('Refreshing Epic Games...', LogPrefix.Legendary)
const epicOffline = await isEpicServiceOffline()
if (epicOffline) {
logWarning(
'Epic is Offline right now, cannot update game list!',
LogPrefix.Backend
)
return { stderr: 'Epic offline, unable to update game list', stdout: '' }
}
const res = await this.runRunnerCommand(
{
subcommand: 'list',
'--third-party': true
},
{
abortId: 'legendary-refresh'
}
)
if (res.error) {
logError(['Failed to refresh library:', res.error], LogPrefix.Legendary)
}
this.refreshInstalled()
return res
}
/**
* Refresh `installedGames` from file.
*/
refreshInstalled() {
const installedJSON = join(legendaryConfigPath, 'installed.json')
let installedCache: [string, InstalledJsonMetadata][] = []
if (existsSync(installedJSON)) {
try {
installedCache = Object.entries(
JSON.parse(readFileSync(installedJSON, 'utf-8'))
)
} catch (error) {
// disabling log here because its giving false positives on import command
logError(
['Corrupted installed.json file, cannot load installed games', error],
LogPrefix.Legendary
)
installedCache = []
}
} else {
installedCache = []
}
const thirdPartyGames = thirdParty.getInstalledGames()
installedCache.push(...thirdPartyGames)
installedGames = new Map(installedCache)
}
private defaultExecResult = {
stderr: '',
stdout: ''
}
/**
* Get the game info of all games in the library
*
* @returns Array of objects.
*/
async refresh(): Promise<ExecResult | null> {
logInfo('Refreshing library...', LogPrefix.Legendary)
if (!LegendaryUser.isLoggedIn()) {
return this.defaultExecResult
}
await this.refreshLegendary()
const arr = await this.applyLocalData()
logInfo(
['Game list updated, got', `${arr.length}`, 'games & DLCs'],
LogPrefix.Legendary
)
return this.defaultExecResult
}
/**
* Refresh games in the user's library using only local data, without network calls.
*/
async refreshLocal(): Promise<void> {
logInfo('Refreshing library locally...', LogPrefix.Legendary)
const arr = await this.applyLocalData()
logInfo(
['Game list updated locally, got', `${arr.length}`, 'games & DLCs'],
LogPrefix.Legendary
)
}
/**
* Load local game data into the library store.
*
* @returns Array of GameInfo objects.
*/
private async applyLocalData(): Promise<GameInfo[]> {
this.loadGamesInAccount()
this.refreshInstalled()
try {
await this.loadAll()
} catch (error) {
logError(error, LogPrefix.Legendary)
}
const arr = Array.from(library.values())
libraryStore.set('library', arr)
return arr
}
getListOfGames() {
return libraryStore.get('library', [])
}
/**
* Get game info for a particular game.
*
* @param appName The AppName of the game you want the info of
* @param forceReload Discards game info in `library` and always reads info from metadata files
* @returns GameInfo
*/
getGameInfo(appName: string, forceReload = false): GameInfo | undefined {
if (!this.hasGame(appName)) {
logWarning(
['Requested game', appName, 'was not found in library'],
LogPrefix.Legendary
)
return undefined
}
// We have the game, but info wasn't loaded yet
if (!library.has(appName) || forceReload) {
this.loadFile(appName)
}
return library.get(appName)
}
/**
* Get game info for a particular game.
*/
async getInstallInfo(
appName: string,
installPlatform: InstallPlatform,
options?: { retries?: number }
): Promise<LegendaryInstallInfo> {
const retries = options?.retries
const cache = installStore.get(appName)
if (cache && cache.manifest) {
logDebug('Using cached install info', LogPrefix.Legendary)
return cache
}
logInfo(`Getting more details with 'legendary info'`, LogPrefix.Legendary)
const command: LegendaryCommand = {
subcommand: 'info',
appName: LegendaryAppName.parse(appName),
'--json': true,
'--platform': LegendaryPlatform.parse(installPlatform)
}
if (await isEpicServiceOffline()) {
command['--offline'] = true
}
const res = await this.runRunnerCommand(command, { abortId: appName })
if (res.error) {
logError(['Failed to get more details:', res.error], LogPrefix.Legendary)
}
try {
const info: LegendaryInstallInfo = JSON.parse(res.stdout)
if (info.manifest) {
installStore.set(appName, info)
return info
} else {
const nextRetry = retries !== undefined ? retries - 1 : 3
if (nextRetry > 0) {
logWarning(
`Install info for ${appName} does not include manifest data. Retrying.`
)
const retriedInfo = await this.getInstallInfo(
appName,
installPlatform,
{
retries: nextRetry
}
)
return retriedInfo
} else {
throw Error(
`Install info for ${appName} does not include manifest data after 3 retries.`
)
}
}
} catch (error) {
throw Error(`Failed to parse install info for ${appName} with: ${error}`)
}
}
/**
* Obtain a list of updateable games.
*
* @returns App names of updateable games.
*/
async listUpdateableGames(): Promise<string[]> {
const isLoggedIn = LegendaryUser.isLoggedIn()
if (!isLoggedIn || !isOnline()) {
return []
}
const epicOffline = await isEpicServiceOffline()
if (epicOffline) {
logWarning(
'Epic servers are offline, cannot check for game updates',
LogPrefix.Backend
)
return []
}
const res = await this.runRunnerCommand(
{ subcommand: 'list', '--third-party': true },
{
abortId: 'legendary-check-updates',
logMessagePrefix: 'Checking for game updates'
}
)
if (res.abort) {
return []
}
if (res.error) {
logError(
['Failed to check for game updates:', res.error],
LogPrefix.Legendary
)
return []
}
// Once we ran `legendary list`, `assets.json` will be updated with the newest
// game versions, and `installed.json` has our currently installed ones
const installedJsonFile = join(legendaryConfigPath, 'installed.json')
let installedJson: Record<string, InstalledJsonMetadata> = {}
try {
installedJson = JSON.parse(
readFileSync(installedJsonFile, { encoding: 'utf-8' })
)
} catch (error) {
logWarning(
['Failed to parse games from', installedJsonFile, 'with:', error],
LogPrefix.Legendary
)
}
// First go through all our installed games and store their versions...
const installedGames: Map<string, { version: string; platform: string }> =
new Map()
for (const [appName, data] of Object.entries(installedJson)) {
installedGames.set(appName, {
version: data.version,
platform: data.platform
})
}
// ...and now go through all games in `assets.json` to get the newest version
// HACK: Same as above, ↓ this isn't always `string`, but it works for now
const assetsJsonFile = join(legendaryConfigPath, 'assets.json')
let assetsJson: Record<string, Record<string, string>[]> = {}
try {
assetsJson = JSON.parse(
readFileSync(assetsJsonFile, { encoding: 'utf-8' })
)
} catch (error) {
logWarning(
['Failed to parse games from', assetsJsonFile, 'with:', error],
LogPrefix.Legendary
)
}
const updateableGames: string[] = []
for (const [platform, assets] of Object.entries(assetsJson)) {
installedGames.forEach(
({ version: currentVersion, platform: installedPlatform }, appName) => {
if (installedPlatform === platform) {
const currentAsset = assets.find((asset) => {
return asset.app_name === appName
})
if (!currentAsset) {
logWarning(
[
'Game with AppName',
appName,
'is installed but was not found on account'
],
LogPrefix.Legendary
)
return
}
const latestVersion = currentAsset.build_version
if (currentVersion !== latestVersion) {
logDebug(
[
'Update is available for',
`${appName}:`,
currentVersion,
'!=',
latestVersion
],
LogPrefix.Legendary
)
updateableGames.push(appName)
}
}
}
)
}
logInfo(
[
'Found',
`${updateableGames.length}`,
'game' + (updateableGames.length !== 1 ? 's' : ''),
'to update'
],
LogPrefix.Legendary
)
return updateableGames
}
/**
* Change the install path for a given game.
*
* DOES NOT MOVE FILES. Use `LegendaryGame.moveInstall` instead.
*
* @param appName
* @param newPath
*/
async changeGameInstallPath(appName: string, newPath: string) {
const libraryGameInfo = library.get(appName)
if (libraryGameInfo) libraryGameInfo.install.install_path = newPath
else {
logWarning(
`library game info not found in changeGameInstallPath for ${appName}`,
LogPrefix.Legendary
)
}
const installedGameInfo = installedGames.get(appName)
if (installedGameInfo) installedGameInfo.install_path = newPath
else {
logWarning(
`installed game info not found in changeGameInstallPath for ${appName}`,
LogPrefix.Legendary
)
}
const { error } = await this.runRunnerCommand(
{
subcommand: 'move',
appName: LegendaryAppName.parse(appName),
newBasePath: Path.parse(dirname(newPath)),
'--skip-move': true
},
{
abortId: appName
}
)
if (error) {
logError(
['Failed to set install path for', `${appName}:`, error],
LogPrefix.Legendary
)
}
}
/**
* Change the install state of a game without a complete library reload.
*
* @param appName
* @param state true if its installed, false otherwise.
*/
installState(appName: string, state: boolean) {
if (state) {
// This assumes that fileName and appName are same.
// If that changes, this will break.
this.loadFile(appName)
} else {
// @ts-expect-error TODO: Make sure game info is loaded & appName is valid here
library.get(appName).is_installed = false
// @ts-expect-error Same as above
library.get(appName).install = {} as InstalledInfo
installedGames.delete(appName)
}
}
private loadGameMetadata(appName: string): GameMetadata {
const fullPath = join(legendaryMetadata, appName + '.json')
return JSON.parse(readFileSync(fullPath, 'utf-8'))
}
/**
* Load the file completely into our in-memory library.
* Largely derived from legacy code.
*
* @returns True/False, whether or not the file was loaded
*/
private loadFile(app_name: string): boolean {
let metadata
try {
const data = this.loadGameMetadata(app_name)
metadata = data.metadata
} catch (error) {
logError(
[`Failed to parse metadata for ${app_name}:`, error],
LogPrefix.Legendary
)
return false
}
const { namespace } = metadata
const ueCategories = ['assets', 'asset-format', 'plugins', 'projects']
const isUeTitle =
namespace === 'ue' ||
!!metadata.categories.find((category) =>
ueCategories.includes(category.path)
)
if (isUeTitle) {
return false
}
const {
description,
shortDescription = '',
keyImages = [],
title,
developer,
dlcItemList,
releaseInfo,
customAttributes,
categories,
mainGameItem
} = metadata
// skip mods from the library
if (categories.some(({ path }) => path === 'mods')) {
return false
}
// skip games that are only available for Android or iOS, obtanied from the Epic Mobile Store app
if (
releaseInfo.every((info) =>
info.platform?.every((plat) => plat === 'Android' || plat === 'iOS')
)
) {
return false
}
if (!customAttributes) {
logWarning(['Incomplete metadata for', app_name], LogPrefix.Legendary)
}
const dlcs: string[] = []
const FolderName = customAttributes?.FolderName
const canRunOffline = customAttributes?.CanRunOffline?.value === 'true'
const thirdPartyManagedApp =
customAttributes?.ThirdPartyManagedApp?.value ||
customAttributes?.ThirdPartyManagedProvider?.value ||
undefined
if (dlcItemList) {
dlcItemList.forEach((v: { releaseInfo: { appId: string }[] }) => {
if (v.releaseInfo && v.releaseInfo[0]) {
dlcs.push(v.releaseInfo[0].appId)
}
})
}
const info = installedGames.get(app_name)
const {
executable,
version,
install_size,
install_path,
platform,
save_path
} = info ?? {}
const saveFolder =
(platform === 'Mac'
? customAttributes?.CloudSaveFolder_MAC?.value
: customAttributes?.CloudSaveFolder?.value) ?? ''
const installFolder = FolderName ? FolderName.value : app_name
const gameBox = keyImages.find(
({ type }) => type === 'DieselGameBox' || type === 'OfferImageWide'
)
const gameBoxTall = keyImages.find(
({ type }) => type === 'DieselGameBoxTall' || type === 'OfferImageTall'
)
const gameBoxStore = keyImages.find(
({ type }) => type === 'DieselStoreFrontTall'
)
const logo = keyImages.find(({ type }) => type === 'DieselGameBoxLogo')
const art_cover = gameBox ? gameBox.url : undefined
const art_logo = logo ? logo.url : undefined
const art_square = gameBoxTall ? gameBoxTall.url : undefined
const art_square_front = gameBoxStore ? gameBoxStore.url : undefined
const is_dlc = Boolean(metadata.mainGameItem)
const convertedSize = install_size ? getFileSize(Number(install_size)) : '0'
if (releaseInfo && !releaseInfo[0].platform) {
logWarning(['No platforms info for', app_name], LogPrefix.Legendary)
}
let metadataPlatform: LegendaryInstallPlatform[] = []
// some DLCs don't have a platform value
if (releaseInfo[0].platform) {
metadataPlatform = releaseInfo[0].platform
} else if (mainGameItem && mainGameItem.releaseInfo[0].platform) {
// when there's no platform, the DLC might reference the base game with the info
metadataPlatform = mainGameItem.releaseInfo[0].platform
}
library.set(app_name, {
app_name,
art_cover: art_cover || art_square || fallBackImage,
art_logo,
art_square: art_square || art_square_front || art_cover || fallBackImage,
cloud_save_enabled: Boolean(saveFolder),
developer,
extra: {
about: {
description,
shortDescription
},
reqs: [],
storeUrl: formatEpicStoreUrl(title)
},
dlcList: dlcItemList,
folder_name: installFolder,
install: {
executable,
install_path,
install_size: convertedSize,
is_dlc,
version,
platform
},
is_installed: info !== undefined,
namespace,
is_mac_native: info
? platform === 'Mac'
: metadataPlatform.includes('Mac'),
save_folder: saveFolder,
save_path,
title,
canRunOffline,
thirdPartyManagedApp,
isEAManaged:
!!thirdPartyManagedApp &&
['origin', 'the ea app'].includes(thirdPartyManagedApp.toLowerCase()),
isUbisoftManaged:
!!thirdPartyManagedApp &&
'ubisoftconnect' == thirdPartyManagedApp.toLowerCase(),
is_linux_native: false,
runner: 'legendary',
store_url: formatEpicStoreUrl(title)
})
return true
}
/**
* Fully loads all files in library into memory.
*
* @returns App names of loaded files.
*/
private async loadAll(): Promise<string[]> {
if (existsSync(legendaryMetadata)) {
const loadedFiles: string[] = []
allGames.forEach((appName) => {
const wasLoaded = this.loadFile(appName)
if (wasLoaded) {
loadedFiles.push(appName)
}
})
return loadedFiles
}
return []
}
/**
* Checks if a game is in the users account
* @param appName The game to search for
* @returns True = Game is in account, False = Game is not in account
*/
hasGame = (appName: string) => allGames.has(appName)
async runRunnerCommand(
command: LegendaryCommand,
options?: CallRunnerOptions
): Promise<ExecResult> {
if (process.env.CI === 'e2e') {
return runLegendaryCommandStub(command)
}
const { dir, bin } = getLegendaryBin()
// Set LEGENDARY_CONFIG_PATH to a custom, Heroic-specific location so user-made
// changes to Legendary's main config file don't affect us
if (!options) {
options = {}
}
if (!options.env) {
options.env = {}
}
// if not on a SNAP environment, set the XDG_CONFIG_HOME to the same location as the config file
if (!process.env.SNAP) {
options.env.LEGENDARY_CONFIG_PATH = legendaryConfigPath
}
const commandParts = this.commandToArgsArray(command)
return callRunner(
commandParts,
{ name: 'legendary', logPrefix: LogPrefix.Legendary, bin, dir },
options
)
}
async getGameOverride(): Promise<GameOverride> {
const cached = gamesOverrideStore.get('gamesOverride')
if (cached) {
return cached
}
try {
const response = await axiosClient.get<ResponseDataLegendaryAPI>(
'https://heroic.legendary.gl/v1/version.json'
)
if (response.data.game_overrides) {
gamesOverrideStore.set('gamesOverride', response.data.game_overrides)
}
return response.data.game_overrides
} catch (error) {
logWarning(['Error fetching Legendary API:', error], LogPrefix.Legendary)
throw error
}
}
async getGameSdl(appName: string): Promise<SelectiveDownload[]> {
try {
const response = await axiosClient.get<Record<string, SelectiveDownload>>(
`https://heroic.legendary.gl/v1/sdl/${appName}.json`
)
// if data type is not a json return empty array
if (response.headers['content-type'] !== 'application/json') {
logInfo(
['No Selective Download data found for', appName],
LogPrefix.Legendary
)
return []
}
const list = Object.keys(response.data)
const sdlList: SelectiveDownload[] = []
list.forEach((key) => {
const { name, description, tags } = response.data[key]
if (key === '__required') {
sdlList.unshift({ name, description, tags, required: true })
} else {
sdlList.push({ name, description, tags })
}
})
return sdlList
} catch (error) {
logWarning(
['Error fetching Selective Download data for', appName, error],
LogPrefix.Legendary
)
return []
}
}
/**
* Toggles the EGL synchronization on/off based on arguments
* @param path_or_action On Windows: "unlink" (turn off), "windows" (turn on). On linux/mac: "unlink" (turn off), any other string (prefix path)
* @returns string with stdout + stderr, or error message
*/
async toggleGamesSync(path_or_action: string) {
if (isWindows) {
const egl_manifestPath =
'C:\\ProgramData\\Epic\\EpicGamesLauncher\\Data\\Manifests'
if (!existsSync(egl_manifestPath)) {
mkdirSync(egl_manifestPath, { recursive: true })
}
}
const command: LegendaryCommand = {
subcommand: 'egl-sync',
'-y': true
}
if (path_or_action === 'unlink') {
command['--unlink'] = true
} else {
command['--enable-sync'] = true
if (!isWindows) {
const pathParse = Path.safeParse(path_or_action)
if (pathParse.success) {
command['--egl-wine-prefix'] = pathParse.data
} else {
return 'Error'
}
}
}
const { error, stderr, stdout } = await this.runRunnerCommand(command, {
abortId: 'toggle-sync'
})
if (error) {
logError(['Failed to toggle EGS-Sync', error], LogPrefix.Legendary)
return 'Error'
} else {
logInfo(`${stdout}`, LogPrefix.Legendary)
if (stderr.includes('ERROR') || stderr.includes('error')) {
logError(`${stderr}`, LogPrefix.Legendary)
return 'Error'
}
return `${stdout} - ${stderr}`
}
}
/*
* Converts a LegendaryCommand to a parameter list passable to Legendary
* @param command
*/
commandToArgsArray(command: LegendaryCommand): string[] {
const commandParts: string[] = []
if (command.subcommand) commandParts.push(command.subcommand)
// Some commands need special handling
switch (command.subcommand) {
case 'install':
commandParts.push(command.appName)
if (command.sdlList) {
commandParts.push('--install-tag=')
for (const sdlTag of command.sdlList)
commandParts.push('--install-tag', sdlTag)
}
break
case 'launch':
commandParts.push(command.appName)
if (command.extraArguments)
commandParts.push(...shlex.split(command.extraArguments))
break
case 'update':
case 'info':
case 'sync-saves':
case 'uninstall':
case 'repair':
commandParts.push(command.appName)
break
case 'move':
commandParts.push(command.appName, command.newBasePath)
break
case 'eos-overlay':
commandParts.push(command.action)
break
case 'import':
commandParts.push(command.appName, command.installationDirectory)
break
}
// Append parameters (anything starting with -)
for (const [parameter, value] of Object.entries(
command
) as Entries<LegendaryCommand>) {
if (!parameter.startsWith('-')) continue
if (!value) continue
// Boolean values (specifically `true`) have to be handled differently
// Parameters that have a boolean type are just signified
// by the parameter being present, they don't have a value.
// Thus, we only add the key (parameter) here, instead of the key & value
if (value === true) commandParts.push(parameter)
else commandParts.push(parameter, value.toString())
}
return commandParts
}
async getLaunchOptions(appName: string): Promise<LaunchOption[]> {
const gameInfo = this.getGameInfo(appName)
const installPlatform = gameInfo?.install.platform
if (!installPlatform || gameInfo.thirdPartyManagedApp) return []
const installInfo = await this.getInstallInfo(appName, installPlatform)
const launchOptions: LaunchOption[] = installInfo.game.launch_options
// Some DLCs are also launch-able
for (const dlc of installInfo.game.owned_dlc) {
const installedInfo = installedGames.get(dlc.app_name)
if (!installedInfo) continue
// If the DLC itself is executable, push it onto the list
if (installedInfo.executable) {
launchOptions.push({
type: 'dlc',
dlcAppName: dlc.app_name,
dlcTitle: dlc.title
})
// The one example we've found using this (Unreal Editor for Fortnite)
// suggests that we should not look at the AdditionalCommandLine custom
// attribute (below) if this is set
continue
}
// Otherwise, if it specifies additional commandline parameters to pass to
// the main game, add it as a basic launch option
let metadata
try {
metadata = this.loadGameMetadata(dlc.app_name)
} catch (e) {
logWarning(
[
'Failed to load DLC metadata for',
dlc.app_name,
'(base game is',
`${appName}):`,
e
],
LogPrefix.Legendary
)
}
if (!metadata?.metadata.customAttributes?.AdditionalCommandLine) continue
launchOptions.push({
type: 'basic',
name: dlc.title,
parameters:
metadata.metadata.customAttributes.AdditionalCommandLine.value
})
}
return launchOptions
}
/* eslint-disable-next-line @typescript-eslint/no-unused-vars */
changeVersionPinnedStatus(appName: string, status: boolean) {
logWarning(
'changeVersionPinnedStatus not implemented on Legendary Library Manager'
)
}
}