leonard-thieu/toofz-steam

.NET library designed for retrieving leaderboards, players, and user-generated content from Steam.

toofz Steam

Overview

toofz Steam is a .NET library designed for retrieving leaderboards, players, and user-generated content from Steam. It includes clients for Steam Client API, Steam Community Data, Steam Web API, and Steam Workshop.

---

toofz Steam is a component of toofz. Information about other projects that support toofz can be found in the meta-repository.

Description

toofz Steam implements clients for various Steam APIs. Only the APIs used by toofz projects are implemented. More APIs may be implemented if there is a demand for it. All clients have support for transient fault handling, telemetry, and cancellation.

Installing via NuGet

Add a NuGet.Config to your solution directory with the following content:

<?xml version="1.0" encoding="utf-8"?>
<configuration>
  <packageSources>
    <add key="toofz" value="https://www.myget.org/F/toofz/api/v3/index.json" />
  </packageSources>
</configuration>

Install-Package 'toofz.Steam'

Dependencies

• toofz Build

Dependents

• toofz Leaderboards Service
• toofz Daily Leaderboards Service
• toofz Players Service
• toofz Replays Service

Requirements

• .NET Standard 2.0-compatible platform
  • .NET Core 2.0
  • .NET Framework 4.6.1
  • Mono 5.4

Contributing

Contributions are welcome for toofz Steam.

• Want to report a bug or request a feature? File a new issue.
• Join in design conversations.
• Fix an issue or add a new feature.
  • Aside from trivial issues, please raise a discussion before submitting a pull request.

Development

Requirements

• Visual Studio 2017

Getting started

Open the solution file and build. Use Test Explorer to run tests.

Repository layout

• ClientApi - Steam Client API client (wrapper around SteamKit)
• CommunityData - Steam Community Data client
• WebApi - Steam Web API client
• Workshop - Steam Workshop client

License

toofz Steam is released under the MIT License.