# Bevy Retro

<p align="center">
    <a href="https://crates.io/crates/bevy_retro" alt="Crates.io">
        <img src="https://img.shields.io/crates/v/bevy_retro.svg" />
    </a>
    <a href="https://docs.rs/bevy_retro" alt="Docs.rs">
        <img src="https://docs.rs/bevy_retro/badge.svg" />
    </a>
    <a href="https://github.com/YendorEngine/bevy_retro/actions/workflows/rust.yaml" alt="Build Status">
        <img src="https://github.com/YendorEngine/bevy_retro/actions/workflows/rust.yaml/badge.svg" />
    </a>
    <a href="https://github.com/YendorEngine/bevy_retro">
        <img src="https://tokei.rs/b1/github/katharostech/bevy_retro?category=code" alt="lines of code">
    </a>
    <a href="https://opensource.org/licenses/MIT">
        <img src="https://img.shields.io/badge/License-MIT-yellow.svg" alt="MIT License">
    </a>
    <a href="https://opensource.org/licenses/Apache-2.0">
        <img src="https://img.shields.io/badge/License-Apache_2.0-blue.svg" alt="Apache 2.0 License">
    </a>
</p>

<div align="center">
    <em>( Screenshot of <a href="https://katharostech.com/post/bounty-bros-on-web">Bounty Bros.</a> game made with Bevy Retro and <a href="https://github.com/katharostech/skipngo">Skip'n Go</a> )</em>
</div>

![bounty bros game screenshot](./doc/bounty_bros.png)

Bevy Retro is an opinionated plugin pack for the [Bevy][__link0] game engine with tools to help you make 2D games!

Bevy Retro is not specific to pixel-art games, but it does include some features that would be particularly useful for pixel games. The ultimate goal is to act as an extension to Bevy that gives you common tools necessary to make a 2D game such as map loading, physics, UI, save-data, etc. Not all of the features we want to add are implemented yet, but we will be expanding the feature set as we developer our own game with it.

## License

Bevy Retro is licensed under the [MIT License] OR [APACHE Liscense]

## Development Status

Bevy Retro is in early stages of development. The API is not stable and may change dramatically at any time.

Now Bevy Retro mostly includes some existing libraries and provides small utilities on top such as the 9-patch style UI addtions for egui.

Since it’s been so long since our last update we want to get another release out soon, just to get everything working again on top of the latest crates.

After that we plan to re-visit what extra features we might want, such as an easier way to setup the 2D camera, and a save data system, and we will look at polishing our integrations and utilities where appropriate.

See also [Supported Bevy Version](#supported-bevy-version) below.

## Features & Examples

Check out our [examples][__link6] list to see how to use each Bevy Retro feature:

- Supports web and desktop out-of-the-box
- [LDtk][__link7] map loading and rendering using .
- An integration with the UI library with extra 9-patch style widgets.
- Text rendering of bitmap fonts in the BDF format
- Physics and collision detection powered by [Rapier][__link10] with automatic generation of convex collision shapes from sprite images.
- Sound playing with .

## Supported Bevy Version

| bevy | bevy_retro   |
| ---- | ------------ |
| 0.9  | 0.3 + master |
| 0.7  | 0.1, 0.2     |
| 0.6  | 0.1, 0.2     |

[__link0]: https://bevyengine.org
[__link1]: https://github.com/katharostech/katharos-license
[__link10]: https://rapier.rs/
[__link11]: https://github.com/NiklasEi/bevy_kira_audio
[__link2]: https://github.com/Trouv/bevy_ecs_ldtk
[__link3]: https://raui-labs.github.io/raui/
[__link4]: https://github.com/mvlabat/bevy_egui
[__link5]: https://github.com/StarArawn/bevy_ecs_tilemap/pull/197
[__link6]: https://github.com/YendorEngine/bevy_retro/tree/master/examples#bevy-retro-examples
[__link7]: https://ldtk.io
[__link8]: https://github.com/Trouv/bevy_ecs_ldtk
[__link9]: https://github.com/emilk/egui
[skipngo]: https://github.com/katharostech/skipngo