{"id":21578357,"url":"https://github.com/brianlima/vdfparser","last_synced_at":"2025-04-10T17:33:40.734Z","repository":{"id":47470921,"uuid":"69380541","full_name":"BrianLima/VDFParser","owner":"BrianLima","description":"Provides facilities to parse and write VDF files into managed objects","archived":false,"fork":false,"pushed_at":"2024-04-07T13:30:05.000Z","size":89,"stargazers_count":11,"open_issues_count":0,"forks_count":9,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-03-24T15:11:17.058Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/BrianLima.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-09-27T17:15:02.000Z","updated_at":"2024-12-08T20:50:26.000Z","dependencies_parsed_at":"2024-11-24T13:10:20.306Z","dependency_job_id":"4c012607-62d6-47b5-aadb-18ffd8ebffae","html_url":"https://github.com/BrianLima/VDFParser","commit_stats":{"total_commits":5,"total_committers":3,"mean_commits":"1.6666666666666667","dds":0.6,"last_synced_commit":"3310e23db9b6021258299fd1e48ca53d4a452a2c"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BrianLima%2FVDFParser","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BrianLima%2FVDFParser/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BrianLima%2FVDFParser/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BrianLima%2FVDFParser/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/BrianLima","download_url":"https://codeload.github.com/BrianLima/VDFParser/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248262020,"owners_count":21074229,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-24T13:10:17.960Z","updated_at":"2025-04-10T17:33:40.699Z","avatar_url":"https://github.com/BrianLima.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# VDFParser\n\u003e Provides facilities to parse and write VDF files into managed objects\n\nVDFParser is a small C# library that allows VDF files (specially as Steam's `shortcuts.vdf`) to be parsed and serialized. By now, the only implemented model is the already mentioned `shortcuts` file, but the FSM may be used to parse any other file, as long as the managed model is implemented using the patterns seen in the `VDFEntry` class.\n\n## Parsing\n\nInvoking the static `VDFParser.Parse` method will yield an array of `VDFEntry` instances. You can either provide a file path or a readable generic `Stream` instance:\n\n```C#\nVDFParser.VDFParser.Parse(\"/tmp/shortcuts.vdf\");\n// =\u003e VDFEntry[] { ... }\n```\n\n## Serializing\n\nThe `VDFSerializer` static class provides a `Serialize` method, that takes a given set of `VDFEntry` instances and returns a `byte` array corresponding to the `shortcuts.vdf` format.\n\n```C#\nVDFSerializer.Serialize(new VDFEntry[] { new VDFEntry { Name = \"...\" } });\n// =\u003e byte[] { ... }\n```\n\n## Other Considerations\nIt was noticed that Steam's do not follow a standard pattern for naming the fields in the mentioned file. You can find `appname` and `AppName` variations, but it appears that it does not enforce a single naming convention. This library was not extensively tested against multiple Steam installations and, therefore, more information or insights about this behavior is welcome.\n\n## License\n```\nMIT License\n\nCopyright (c) 2016 Victor Gama\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbrianlima%2Fvdfparser","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbrianlima%2Fvdfparser","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbrianlima%2Fvdfparser/lists"}