steam_shortcuts_util

Crates.iosteam_shortcuts_util
lib.rssteam_shortcuts_util
version1.1.8
sourcesrc
created_at2021-08-29 11:24:57.475286
updated_at2022-05-20 21:15:24.157377
descriptionUtilities for parsing & writing Steams shortcut.vdf file format
homepage
repositoryhttps://github.com/PhilipK/steam_shortcuts_util
max_upload_size
id443711
size139,887
Philip Kristoffersen (PhilipK)

documentation

https://docs.rs/steam_shortcuts_util/0.1.0/steam_shortcuts_util/

README

Steam Shortcuts utility

Steam Shortcuts is a utility crate that helps you to manage your Steam shortcuts. It is a simple Rust crate that provides a simple interface to manage your Steam shortcuts.

Getting started

First include the crate in your project:

[dependencies]
steam_shortcuts_util = "1.0.0"

Then you can use it:

 use steam_shortcuts_util::parse_shortcuts;
 use steam_shortcuts_util::shortcuts_to_bytes;

 fn example() -> Result<(), Box<dyn std::error::Error>> {
     // This path should be to your steam shortcuts file
     // Usually located at $SteamDirectory/userdata/$SteamUserId/config/shortcuts.vdf
     let content = std::fs::read("src/testdata/shortcuts.vdf")?;
     let shortcuts = parse_shortcuts(content.as_slice())?;
     assert_eq!(shortcuts[0].app_name, "Celeste");
     assert_eq!(3, shortcuts[0].tags.len());

     let shortcut_bytes_vec = shortcuts_to_bytes(&shortcuts);
     assert_eq!(shortcut_bytes_vec, content);
     Ok(())
 }

Be aware that if you overwrite the shortcuts.vdf file, you will have to restart Steam for the changes to take effect.

Commit count: 27

cargo fmt