Skip to content

Commit

Permalink
Slim down the readme
Browse files Browse the repository at this point in the history
Versioning is a weird topic, as every Bevy release is a breaking release. Unless there is a need for a dependency matrix, I will stop maintaining it for now.

But, FMOD updates are infrequent and backwards compatible. So need for a badge for now.
  • Loading branch information
Salzian committed Jul 29, 2024
1 parent d75e5e3 commit a432396
Showing 1 changed file with 9 additions and 27 deletions.
36 changes: 9 additions & 27 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
# bevy_fmod

![Latest compatible Bevy version][Bevy 0.13 img]
![Latest compatible FMOD version][FMOD 2.02.20 img]
![Latest compatible Bevy version][Bevy badge]
![License][License img]
![GitHub release][GitHub release img]

Expand All @@ -20,7 +19,8 @@ Learn more [here][FMOD attribution].

## Supported platforms

Currently, this crate is only tested and developed for Windows (non-UWP) and Linux. More platforms are planned eventually.
Currently, this crate is only tested and developed for Windows (non-UWP) and Linux. More platforms are planned
eventually.

MacOS: https://github.com/Salzian/bevy_fmod/issues/2
Web: https://github.com/Salzian/bevy_fmod/issues/51
Expand All @@ -34,7 +34,8 @@ libraries [here][FMOD libraries download].
This requires a free FMOD account.

### Windows
- Download the "FMOD Engine" package for Windows. Make sure to select [a compatible version](#versioning).

- Download the "FMOD Engine" package for Windows.
- Install the package.
- You need the following 4 files in the root of your rust project:
- `api/core/lib/x64/fmod.dll`
Expand All @@ -44,9 +45,10 @@ This requires a free FMOD account.

### Linux

Below are the steps for a fairly minimal method to link the libraries. See the comments in [build.rs](https://github.com/Salzian/bevy_fmod/blob/main/build.rs) for more information.
Below are the steps for a fairly minimal method to link the libraries. See the comments
in [build.rs](https://github.com/Salzian/bevy_fmod/blob/main/build.rs) for more information.

- Download the "FMOD Engine" package for Linux. Make sure to select [a compatible version](#versioning).
- Download the "FMOD Engine" package for Linux.
- Create a new folder `fmod` in the root of your project.
- Extract the `api` folder into it.
- Copy the contents of [build.rs](https://github.com/Salzian/bevy_fmod/blob/main/build.rs) into your own build script.
Expand Down Expand Up @@ -84,29 +86,9 @@ to explicitly enable it with the `--features` flag. This way, you won't accident
cargo run --example minimal --features live-update
```

## Versioning

| bevy_fmod | Bevy | FMOD (tested version, newer may work) |
|-----------|---------------------------------------|-------------------------------------------------------|
| 0.4.0 | [![0.13][Bevy 0.13 img]][Bevy 0.13] | [![2.02.20][FMOD 2.02.20 img]][FMOD revision history] |
| 0.3.0 | [![0.11.2][Bevy 0.11 img]][Bevy 0.11] | [![2.02.12][FMOD 2.02.12 img]][FMOD revision history] |
| 0.2.0 | [![0.11.2][Bevy 0.11 img]][Bevy 0.11] | [![2.02.12][FMOD 2.02.12 img]][FMOD revision history] |
| 0.1.0 | [![0.10.0][Bevy 0.10 img]][Bevy 0.10] | [![2.02.12][FMOD 2.02.12 img]][FMOD revision history] |
| 0.0.1 | [![0.10.0][Bevy 0.10 img]][Bevy 0.10] | [![2.02.12][FMOD 2.02.12 img]][FMOD revision history] |

[Bevy]: https://bevyengine.org

[Bevy 0.10]: https://bevyengine.org/news/bevy-0-10/

[Bevy 0.10 img]: https://img.shields.io/badge/Bevy-0.10-232326

[Bevy 0.11]: https://bevyengine.org/news/bevy-0-11/

[Bevy 0.11 img]: https://img.shields.io/badge/Bevy-0.11-232326

[Bevy 0.13]: https://bevyengine.org/news/bevy-0-13/

[Bevy 0.13 img]: https://img.shields.io/badge/Bevy-0.13-232326
[Bevy badge]: https://img.shields.io/badge/Bevy-0.14-232326

[FMOD licensing]: https://fmod.com/licensing

Expand Down

0 comments on commit a432396

Please sign in to comment.