Feature: Automatic backup after playing a game #235

sluedecke · 2023-06-27T12:14:46Z

Moving the discussion from #211 into this pull request.

Currently known work items:

Leverage existing code if possible: Instead of parsing the info/goggame files, maybe we can reuse launchers.rs/heroic.rs. The Launchers struct could store some extra info (probably the numeric ID and/or the Heroic name) for each game to facilitate a reverse mapping to Ludusavi's normal name.
"Fully" support heroic on Linux by adding support for legendary
Add a --gui parameter for a notification like window showing backup/restore progress

Feedback is very welcome.

…a game Reflects the core function of ludusavi-launcher.sh minus the UI message and logging. Please consider this a proof of concept.

. renamed "launcher" to "wrap" . moved launcher detection from command line parameters into wrap::get_game_name_from_launch_commands . moved gog gameinfo file deserialization info into wrap/gog.rs . added initial Error::WrapCommandNotRecognized

. actual values not yet taken into account

mtkennerly · 2023-06-29T04:28:40Z

Thanks again for working on this :D

Add a --gui parameter for a notification like window showing backup/restore progress

If possible, I would prefer to stick with regular console output for this. Is it possible to have a console window show up when Heroic(/etc) run the command?

sluedecke · 2023-07-03T19:16:34Z

Unfortunately I did not find any option to launch a game in a terminal (or show it) in heroic 2.8.0.

Even if it did exist, I would still like to have a --gui option. I often use my steam deck or the convertible mode of my 2in1 laptop so that I have a touchscreen only. For this scenario a GUI with some buttons (e.g. for error conditions) would be ideal.

What do you think?

BTW: I adjusted the clap configuration and it now requires either the --infer or the --name to be used.

Wrap restore/backup around game execution

USAGE:
    ludusavi wrap [OPTIONS] <--infer <LAUNCHER>|--name <NAME>> [COMMANDS]...

ARGS:
    <COMMANDS>...    Commands to launch the game, separated by --

OPTIONS:
        --gui                 Show a GUI notification during restore/backup
    -h, --help                Print help information
        --infer <LAUNCHER>    Infer game name from commands based on launcher
                              type [possible values: heroic]
        --name <NAME>         Directly set game name as known to ludusavi

PS: Due to real life reasons I am quite slow with implementing this feature.

. either --name or --infer TYPE is now required . implemented --name and --infer . println prefixed . Subcommand::Wrap uses a label to break out of the match arm if any error occurs

sluedecke · 2023-07-03T20:41:10Z

Ok, so far this works with Dead Cells quite nicely. Still I am missing the visual feedback about the backup/restore process.

mtkennerly · 2023-07-04T14:28:58Z

Even if it did exist, I would still like to have a --gui option. I often use my steam deck or the convertible mode of my 2in1 laptop so that I have a touchscreen only. For this scenario a GUI with some buttons (e.g. for error conditions) would be ideal.

That's a fair point. I don't mind if we can keep it simple, using native_dialog::MessageDialog to show a summary message on exit or failure.

If we don't already have the necessary messages, we may be able to reuse some from the Ludusavi Playnite plugin.

PS: Due to real life reasons I am quite slow with implementing this feature.

Not a problem at all :)

sluedecke · 2023-07-06T21:30:10Z

That's a fair point. I don't mind if we can keep it simple, using native_dialog::MessageDialog to show a summary message on exit or failure.

Yes, simple it should be, just some spinner/indefinite progress that indicates that we restore/backup.

native_dialog is interesting and much easier to use than diving into iced :) But all supported dialogs require a user confirmation, I would love to show some progress indicator during backup/restore and only require user interaction if something went wrong. native_dialog does not (yet) support progress like dialogs: native-dialog-rs/native-dialog-rs#19.

notify_rust sounds interesting, but somehow close on MacOS and Windows: https://docs.rs/notify-rust/latest/notify_rust/#platform-differences are not present? Still it has good stats on crates.io (All-Time: 1.543.357, Recent: 179.114), so I'll try that one. Or do know about another option?

If we don't already have the necessary messages, we may be able to reuse some from the Ludusavi Playnite plugin.

Nice, very useful!

mtkennerly · 2023-07-07T00:06:18Z

I don't think rfd does progress bars either. If we want that, then I think we'd be better off using Iced, but that would add quite a bit of complexity here.

I wonder if something like this would work:

Heroic launches Ludusavi in the background
Ludusavi launches another instance of itself in a visible console (if not already isatty). The first instance waits for the second instance to close
The second instance shows progress in the console. If there's an error, then it shows a dialog, but otherwise, it just closes when it's done

That would still provide the touch-friendliness when something goes wrong, but simplify the progress reporting. What do you think? I can try to help prototype the relaunching part if you'd like.

. use native_dialog to show confirmations and error alerts, not yet respecting --gui . user can abort before restoration (preparing for error handling if backup and actual saves differ) . some variables renamed and TODOs added . cargo update

sluedecke · 2023-07-12T13:30:54Z

I don't think rfd does progress bars either. If we want that, then I think we'd be better off using Iced, but that would add quite a bit of complexity here.

Yes, although one could capture it in the wrap module, it is much more than a single call to a function.

I wonder if something like this would work:
* Heroic launches Ludusavi in the background
* Ludusavi launches another instance of itself in a visible console (if not already `isatty`). The first instance waits for the second instance to close
* The second instance shows progress in the console. If there's an error, then it shows a dialog, but otherwise, it just closes when it's done
That would still provide the touch-friendliness when something goes wrong, but simplify the progress reporting. What do you think? I can try to help prototype the relaunching part if you'd like.

Hm ... somehow this feels like breaking the KISS principle, so I vote for keeping this as a future option.

It would be nice to have some progress or information about the actual backup/restore, but I don't see it as mission critical yet. Much more important IMHO are user feedbacks when something goes wrong and for that native_dialog provides a confirmation and alert dialog (like overwriting not yet backed up files, restoring for the first time, restoration failed, ...).

In a first step I made use of it and added confirmations (some to be removed later on) and alerts to the code.

PS: I tried notify_rust, but dropped it, for errors we need user feedback which cannot be silenced (do not disturb on my machine hides all notifications).

. created modules wrap::gogdl and wrap::legendary and moved command line parsing into them . dropped module wrap::gog, it contained a single data definition now in wrap::gogdl . refactored command line parsing for heroic gogdl to be much more rust ideomatic . get_game_name_from_heroic_launch_commands now only uses find_map on a vector of LaunchParsers

. does not yet handle backup case well (e.g. no restore file, still launching game, then backup doesn't use TitleFinder and will fail for 'Slain: Back From Hell') . Still 'Slain: Back From Hell' now works if you have an initial backup

NOTE: In order to get error messages on stdout: . temporarily add `.duplicate_to_stdout(flexi_logger::Duplicate::All)` in main.rs to `prepare_logging` . run with `RUST_LOG=ludusavi::cli=debug,ludusavi::wrap=debug`

. "Desperados III" is named "Desperados 3" in the goggame-*.info which does not map to the manifest, but the gog_store/library is correct. Since we already read that in module scan::launchers::heroic, I made it a `pub fn` there and replaced the lengthy goggame-*.info reading code with a call to this fn. . For that, the roots configuration needs to be passed into the wrapper

sluedecke · 2023-07-15T05:20:47Z

@mtkennerly I am making quite good progress, but the automatic checks fail since 600a0f8 and "I didn't change anything". At least not in the code which causes the errors. Any idea why that is?

mtkennerly · 2023-07-15T06:18:57Z

It looks like those are new lints from Rust 1.71.0, which just came out. Fixed in master with f67bd18.

. refactored scan/launchers/heroic/get_legendary_installed_games out of detect_legendary_games into separate routine . use it in wrap/legendary.rs instead of calling `legendary` for info . some renaming and comments adjustments

. messages to user somewhat improved in formatting

mtkennerly

Just some feedback on the progress so far :)

mtkennerly · 2023-07-28T15:50:08Z

src/cli.rs

+                &manifest,
+                &BackupLayout::new(config.restore.path.clone(), config.backup.retention.clone()),
+            );
+            match title_finder.find_one(&[normalize_title(&game_name)], &None, &None, true, false, true) {


Since we call find_one with normalize=true, there's no need to call normalize_title pre-emptively.

Ic. I didn't get the meaning of find_ones parameters since they are not documented.
Could you be so kind and describe them in the source code?
And thanks for the hint!

Could you be so kind and describe them in the source code?

Yeah, I should really add some documentation throughout the code base 😅 I'll try to improve that when I can.

mtkennerly · 2023-07-28T15:50:49Z

src/cli.rs

+                            game_name
+                        ))
+                        .set_type(native_dialog::MessageType::Warning)
+                        .show_confirm()


It would be good to have a --force option that bypasses this.

Agreed, also the --gui needs to be respected. I plan to move the UI related stuff into helper routines to make cli.rs a bit less long. Perhaps something like: wrap::ui_show_error(gui_flag, msg) or wrap::ui_get_confirmation(gui_flag, msg) -> bool (guiflag determines whether to show a UI or use the terminal)?

That sounds good to me :)

mtkennerly · 2023-07-28T15:55:18Z

src/cli.rs

+                    break 'wrap;
+                }
+            };
+            if let Err(err) = run(


Right now, run is only meant to be called once, since it loads the config/cache and initializes Rayon. We'll probably want to split the backup portion into its own handle_backup function that's safe to reuse. That would also make it easier to return some granular information, if we need it here.

mtkennerly · 2023-07-28T16:41:48Z

src/cli.rs

+            //
+            // Check if ludusavi is able to back up
+            //
+            match title_finder.find_one(&[normalize_title(&game_name)], &None, &None, true, true, false) {


We already checked this earlier in the wrap command, and we only get here if the user said yes to "Continue to launch game anyways", right? We shouldn't need to check/warn again here, unless I'm missing something.

I think you are right. I will rework the logic in the ::Wrap part to be more clear.

mtkennerly · 2023-07-28T16:47:38Z

src/cli.rs

+            //
+            // execute commands
+            //
+            // TODO.2023-07-12 legendary returns immediately, handle this!


I'm not sure how we'd handle this other than specifying a process ID to monitor. Do you know how Heroic handles this?

I didn't find the spot in heroics source code. Although I am proficient with Typescript/Javascript, it still goes beyond my understanding (which is unexpected). So I will have to have a closer look.

During actual execution the game is started AND the confirmation for making a backup is shown. The game window is drawn over this confirmation and once the game is left, I can initiate the backup. So it kind of works, but it is a confusing behaviour. Especially when the game needs a couple of seconds to launch....

src/wrap.rs

src/wrap/legendary.rs

sluedecke · 2023-07-30T18:54:13Z

Thank you for the very welcome feedback! I will start working on resolutions, until then the new heroic 2.9.0 release broke this mechanism and I will adapt this branch to it as well.

sluedecke · 2023-09-15T10:56:17Z

Slain does not work correctly, because heroic calls ludusavi with XDG_CONFIG_HOME=/home/saschal/.config/heroic/legendaryConfig which causes ludusavi to use a default config.yaml which for sure does not find the folder where I store the backups.

As such ludusavi behaves correctly by respecting the variable, although this will not work properly for any wrappers in heroic and Epic/legendary games. Is this a bug in heroic?

. also commented on heroic setting XDG_CONFIG_HOME for legendary thus making use ludusavi a default configuration which in turn leads to backups not found.

sluedecke · 2023-09-15T12:43:54Z

Slain now works, too. But only if ludusavi bypasses XDG_CONFIG_HOME by being invoked with --config.

@mtkennerly : do you think the heroic team sees this as a bug or at least as something to be changed? Setting XDG_CONFIG_HOME for legendary makes life for wrappers which use this to retrieve configurations hard.

mtkennerly · 2023-09-25T09:00:46Z

I'm not sure if Heroic could really do much differently there. Even if Heroic didn't invoke Legendary with a custom XDG_CONFIG_HOME, Flatpak would still override the env var when running Heroic itself. Heroic wouldn't have any way to know Ludusavi's normal XDG_CONFIG_HOME value.

It could be worth adding a Heroic env var to identify the Heroic config folders, but at least for Ludusavi, I think --config is fine since we'll have the Heroic folder configured as a root.

sluedecke · 2023-10-05T10:57:34Z

Thanks for the response rg. legendary. So far the feature is quite usable and I have been testing it for a while with a handful of GOG based games both on my laptop and my steam deck (YMMV).

But there are still some things to consider before finalizing it:

UI logic: simply start the game if the backup == current state
Amazon Prime (nile) support
legendary: improved support beyond using --config
updating README.md
use I18n for prompts

@mtkennerly:
What do you think is needed next for this feature?

. works fine for "Encased: A Sci-Fi Post-Apocalyptic RPG" which is known to ludusavi as "Encased" . game name detection routines now return a WrapGameInfo struct . added some documentation to scan/title.rs::find()

. game names like "Dungeon of the ENDLESS™ - Definitive Edition" did not work with zenity (silent crashes) so game name is no longer used in UI dialogs . fix: unsafe usage of `unwrap()` caused crashes if no backup to restore was found . backup logic now uses WrapGameInfo to determine whether we can back this game up or not

. added initial section to README . dropped now unneeded WrapCommandNotRecognized error . removed many now unneeded debug messages from cli.rs . dropped wrap::get_game_info_from_heroic_launch_invocation since it no longer iterates over a list of functions, replaced with wrap::heroic::parse_heroic_environment_variables which is now public

mtkennerly · 2023-11-15T14:34:01Z

Hey, sorry for leaving this hanging for so long. I'll try to make some time in the next few days to re-review and get this merged in :)

sluedecke · 2023-11-15T15:52:14Z

No worries, good to see you back :)

I would like to iron out some things before I submit this for feedback.

The section in the README needs more details and the messages in the UI are somwnat inconsistent.

Also the linter complains on ubuntu, I can try to appy the recommended fixes, too.

mtkennerly · 2023-12-07T15:49:53Z

@sluedecke Hey, I just did some refactoring. When you have some time, would you mind testing this out and making sure everything still looks good on your end?

There are a couple spots I might try tweaking some more, but I think this is just about ready to merge :)

sluedecke · 2023-12-08T08:18:50Z

Thanks for the refactoring, there are some new usages of rust in it for me:) I will test it.

sluedecke · 2023-12-09T13:18:39Z

Looks good to me, tested on a Linux PC and my Steam Deck, both with a game which already has a backup and with a freshly installed game. Used --gui only though.

So this one should be ready for merging.

mtkennerly · 2023-12-10T02:37:35Z

Awesome! Thanks again for your work on this :)

NL-TCH · 2023-12-27T01:14:34Z

sorry for commenting on this closed PR, but in my opinion it is still not clear how to autobackup a steamgame? what must the launchcommand be?
Gr TCH

mtkennerly · 2023-12-29T07:00:43Z

@NL-TCH Here's an example for Steam on Windows:

Create a file C:\tmp\ludusavi-wrap-steam.cmd with this content:

C:\opt\ludusavi.exe find --steam-id %STEAMAPPID% > C:\tmp\ludusavi-wrap-steam.tmp
set /p GAME_NAME= < C:\tmp\ludusavi-wrap-steam.tmp
C:\opt\ludusavi.exe wrap --name "%GAME_NAME%" --gui -- %*

In Steam:
- Right click on a game
- Open the properties
- Set the launch options to: C:\tmp\ludusavi-wrap-steam.cmd %command%

mtkennerly · 2023-12-29T07:12:17Z

In the next release, I'll update the wrap command so that you'll only need to set the launch options to: C:\opt\ludusavi.exe wrap --infer steam --gui -- %command%

sluedecke added 5 commits June 23, 2023 10:40

Initial work ludusavi mtkennerly#211: Automatic backup after playing …

1d1ca22

…a game Reflects the core function of ludusavi-launcher.sh minus the UI message and logging. Please consider this a proof of concept.

More TODOs in comments

f6d70db

Merge branch 'master' into feature/launcher

4a59d20

Wrap: reworked command line parameters to include --infer and --name

4a695e6

. actual values not yet taken into account

Wrap fails and exits early, one of --name / --infer required

7ad5d8e

. either --name or --infer TYPE is now required . implemented --name and --infer . println prefixed . Subcommand::Wrap uses a label to break out of the match arm if any error occurs

sluedecke added 9 commits July 12, 2023 15:32

Merge branch 'master' into feature/launcher

47401a9

Added *~ to .gitignore thus ignoring emacs backup files

5b54499

Implemented legendary game launch parsing

2d43496

Reviewed and fixed handling of user interactions for restore/backup

600a0f8

Check whether ludusavi knows how to backup a game, more code comments

4a0e554

Replaced println!() with log::info!/debug!/error! as fits

0352622

NOTE: In order to get error messages on stdout: . temporarily add `.duplicate_to_stdout(flexi_logger::Duplicate::All)` in main.rs to `prepare_logging` . run with `RUST_LOG=ludusavi::cli=debug,ludusavi::wrap=debug`

sluedecke added 3 commits July 15, 2023 14:14

Merge branch 'master' into feature/launcher

25a745d

Skip restore if no restorable backup was found

5e5db57

. messages to user somewhat improved in formatting

mtkennerly reviewed Jul 28, 2023

View reviewed changes

Improve game name matching with better usage of title_finder.find_one

175fd74

. also commented on heroic setting XDG_CONFIG_HOME for legendary thus making use ludusavi a default configuration which in turn leads to backups not found.

Respect --gui flag and use terminal for prompts if it is not set

35ec6a6

sluedecke added 3 commits November 11, 2023 18:20

Added using gog_id for game name detection as well

7d25987

. works fine for "Encased: A Sci-Fi Post-Apocalyptic RPG" which is known to ludusavi as "Encased" . game name detection routines now return a WrapGameInfo struct . added some documentation to scan/title.rs::find()

lgcavalheiro mentioned this pull request Dec 4, 2023

Integrate Save Export Heroic-Games-Launcher/HeroicGamesLauncher#3285

Open

mtkennerly added 5 commits December 5, 2023 19:06

Merge branch 'master' into feature/launcher

04fd530

Adjust documentation

cfd7508

Streamline some logic

e45b164

Generalize the wrap UI module

d1aeb08

Move wrap strings to translator

e189a4a

Simplify some usage of TitleFinder

34e110b

mtkennerly merged commit c886676 into mtkennerly:master Dec 10, 2023
9 checks passed

mtkennerly added this to the v0.22.0 milestone Dec 10, 2023

sluedecke deleted the feature/launcher branch December 10, 2023 19:36

sluedecke mentioned this pull request Dec 14, 2023

Automatic backup after playing a game #211

Closed

mtkennerly mentioned this pull request Feb 16, 2024

Does the wrap command not support custom games? #312

Closed

Feature: Automatic backup after playing a game #235

Feature: Automatic backup after playing a game #235

Conversation

sluedecke commented Jun 27, 2023 • edited Loading

mtkennerly commented Jun 29, 2023

sluedecke commented Jul 3, 2023

sluedecke commented Jul 3, 2023

mtkennerly commented Jul 4, 2023

sluedecke commented Jul 6, 2023

mtkennerly commented Jul 7, 2023

sluedecke commented Jul 12, 2023 • edited Loading

sluedecke commented Jul 15, 2023

mtkennerly commented Jul 15, 2023

mtkennerly left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sluedecke commented Jul 30, 2023

sluedecke commented Sep 15, 2023 • edited Loading

sluedecke commented Sep 15, 2023

mtkennerly commented Sep 25, 2023

sluedecke commented Oct 5, 2023

mtkennerly commented Nov 15, 2023

sluedecke commented Nov 15, 2023

mtkennerly commented Dec 7, 2023

sluedecke commented Dec 8, 2023

sluedecke commented Dec 9, 2023

mtkennerly commented Dec 10, 2023

NL-TCH commented Dec 27, 2023

mtkennerly commented Dec 29, 2023

mtkennerly commented Dec 29, 2023

sluedecke commented Jun 27, 2023 •

edited

Loading

sluedecke commented Jul 12, 2023 •

edited

Loading

sluedecke commented Sep 15, 2023 •

edited

Loading