#steam #file-format #parser #api

steam_shortcuts_util

Utilities for parsing & writing Steams shortcut.vdf file format

9 stable releases

1.1.8 May 20, 2022
1.1.7 Apr 18, 2022
1.1.5 Oct 23, 2021
1.1.4 Sep 28, 2021
1.0.0 Aug 29, 2021

#1510 in Parser implementations

Download history 61/week @ 2024-07-19 115/week @ 2024-07-26 33/week @ 2024-08-02 17/week @ 2024-08-09 11/week @ 2024-08-16 14/week @ 2024-08-23 20/week @ 2024-08-30 24/week @ 2024-09-06 17/week @ 2024-09-13 28/week @ 2024-09-20 28/week @ 2024-09-27 19/week @ 2024-10-04 18/week @ 2024-10-11 11/week @ 2024-10-18 43/week @ 2024-10-25 41/week @ 2024-11-01

115 downloads per month
Used in 2 crates

MIT/Apache

35KB
702 lines

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.

Dependencies

~1.5MB
~25K SLoC