Skip to content

Commit

Permalink
Merge pull request #12 from QueenOfSquiggles/dev
Browse files Browse the repository at this point in the history
Added information to readme
  • Loading branch information
QueenOfSquiggles authored Oct 5, 2024
2 parents 2e13942 + 83cc9a9 commit 8cd3f1c
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,24 @@ optionally you can add `rev="<commit>"` or `rev="<tag>"` to specify a specific v
The steamworks crate comes bundled with the redistributable dynamic libraries
of a compatible version of the SDK. Currently it's v158a.

### Enabling Serde support for Steamworks
If you wish to enable serde support add the following:

```toml
[dependencies]
bevy-steamworks = { git = "https://github.com/QueenOfSquiggles/bevy_steamworks.git", features = ["serde"] }
```

### Enabling development features

Some additional features are available for ease of development, notably `SteamworksPlugin::init_dev` which initializes a version of the plugin using the Spacewar App ID which is commonly used for SDK testing since it's an example game by Valve.

```toml
[dependencies]
bevy-steamworks = { git = "https://github.com/QueenOfSquiggles/bevy_steamworks.git", features = ["dev"] }

```

## Usage

To add the plugin to your app, simply add the `SteamworksPlugin` to your
Expand Down

0 comments on commit 8cd3f1c

Please sign in to comment.