rgunti/beatsaberkeeper

Keep your versions of BeatSaber

beatsaberkeeper's Issues

[BUG] Steam Downloads stop after around 3/4

Multiple people have reported that the download doesn't finish and stops around the 75% mark.

Branding Confusion

The app is spelled differently in different places. Unify the naming.
The correct way to spell it is "BeatSaberKeeper" or "BSK" for short.

Allow changing storage directory

Provide an option to change the storage directory of BSK to a different folder (i.e. User Profile or custom directory)

As a first implementation, provide a command line switch to do that as the configuration file wouldn't help here (since it also lives in the .bsk folder)

Automate SteamCMD away

Ideally, the user should not need to interact with SteamCMD.

Add logging for issue resolution

Add logging to client so issues can be documented and resolved quicker.

Provide user a settings option to enable Debug logging.

Add button to "Update" Archive

Add a button to the context menu to update the selected archive with the current state.

Update website with documentation

Add documentation about how to use the app to the website. (Adjustments to the website are of course also welcome.)

Cleanup projects

We have some old legacy projects in the repo. This should be cleaned up so we don't build things we don't want to have anyway.

BSK CLI

Being able to create and extract archive from CLI

Use Song Explorer to list maps from archives

Add option to only extract the archive but not launch it

Get downloader to work again

There is a project that patches Steam to allow downgrades again: https://github.com/fifty-six/zig.SteamManifestPatcher/releases

Find out if it is applicable to SteamCMD as well and we might get the old downloader to work again.

Add ability to backup only Plugins and Custom*

Like #1 but skip the game data and only add certain files to the archive.
Also versioning would be great.

Versioning

Make archive only store differences
This will require a new Archive Version to be implemented

[BUG] Double-clicking items doesn't extract

Describe the bug
Cannot double-click to unpack and start game.

To Reproduce
N/A

Expected behavior
When double-clicking an archive, the unpack process starts and the game is started afterwards.

Screenshots
N/A

Desktop (please complete the following information):
N/A

Additional context
N/A

Song Explorer

Have an option to explore stored songs in archives (and play them)

[BUG] Various crashes when no GamePath is set

Describe the bug
If no path is set, some features cause the app to crash.

To Reproduce
N/A

Expected behavior
N/A

Screenshots
N/A

Desktop (please complete the following information):
N/A

Additional context
N/A

Flatten v2 Archive History

Implement a feature so the archive history can be flattened. This should reduce the file size.
From the history, work out which files are still required and delete old ones. This would be the same as unpacking archive and then packing the folder content into a new archive.

Allow to "just unpack" the artifact

Parse Version Info correctly in Updater

Updater logic currently works like this:

if (runningVersion != latestVersion) {
  notify();
}

This makes local development annoying since current local version is always different from latest version.

Parse the version and evaluate if the version is really newer.

Check for new version on GitHub

Remove v1 Archive Support

Remove support for v1 archives, making v2 the only supported archive format.

Update version file

[BUG] App crashes when no internet connection is available

Describe the bug
BSK crashes on update check when no internet connection is available. No logs available

To Reproduce
Steps to reproduce the behavior:

1. Have no internet connection
2. Start BSK
3. Wait for a few seconds
4. Expect crash

Expected behavior
A failing update check should simply register in the status bar (and logs) but not cause the app to crash.

Screenshots
N/A

Desktop (please complete the following information):

• OS: Windows 10
• Version 20H2

Additional context
N/A

Abstract Packer

The archive packer is currently implemented in a static class. We should have an interface in the code that abstracts every feature away. Parts of this interface should be:

• Pack Archive
• Update Archive
• Read Metadata
• ...

This should be done before implementing #18

Rewrite full-release pipeline

The full-release pipeline was a copy-job from a template. The CI and CD Prerelease Pipelines are much cleaner and should be preferred.

"Could not locate game being injected!" appears when launching game

This error appears sometimes when launching the game after extraction. When launched through Explorer, the game launches fine.

[BUG] Song Explorer doesn't release files after playing

Describe the bug
After playing songs, files are kept in use making them unable to be deleted.

To Reproduce
N/A

Expected behavior
N/A

Screenshots
N/A

Desktop (please complete the following information):
N/A

Additional context
N/A

[BUG] Process Dialog might show incorrect status when working on a long task

Due to the throttling of the process dialog, when no updates come it, the reflected status might be incorrect.
To improve diagnostics, the dialog should buffer status changes and update the display every X showing the newest status message.

[BUG] "System.IO.IOException: Stream was too long." when packing larger files

Describe the bug
When packing larger files, BSK can run out of memory and throw an IOException with the above mentioned message.

To Reproduce
Place a larger file (multiple gigabytes) and pack an archive.

Expected behavior
n/a

Screenshots
n/a

Desktop (please complete the following information):
n/a

Additional context
n/a

[BUG] Steam Guard doesn‘t seem to work via email

User reported that Steam Guard didn't work. They used email, not the mobile app.