Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mrgvsv/bevy_tileset_map
https://github.com/mrgvsv/bevy_tileset_map
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/mrgvsv/bevy_tileset_map
- Owner: MrGVSV
- License: other
- Created: 2022-02-17T02:44:21.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2022-11-14T01:27:37.000Z (about 2 years ago)
- Last Synced: 2024-10-04T13:21:03.382Z (4 months ago)
- Language: Rust
- Size: 945 KB
- Stars: 20
- Watchers: 1
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE-APACHE
Awesome Lists containing this project
README
# bevy_tileset_map
[](https://crates.io/crates/bevy_tileset_map)
[](https://docs.rs/bevy_tileset_map)
An implementation of [`bevy_tileset`](https://github.com/MrGVSV/bevy_tileset) for
the [`bevy_ecs_tilemap`](https://github.com/StarArawn/bevy_ecs_tilemap) crate.
## đ Features
All features from `bevy_tileset`, including:
- Define tilesets and tiles via [RON](https://github.com/ron-rs/ron) files
- Load a tileset directly as a Bevy asset
- Define Standard, Animated, Variant, and Auto tiles
As well as features specific to this crate:
* Super easy serialization and deserialization
* Auto tiling support
* Compact tile placement/removal
## đ˛ Installation
This crate is still not publicly released yet as I might want to make a PR to try and integrate it directly
with `bevy_ecs_tilemap`, but for now you can use it with git:
```toml
[dependencies]
bevy_tileset_map = "0.5"
# Don't forget to add `bevy_ecs_tilemap` to your project!
bevy_ecs_tilemap = "0.6"
```
## ⨠Usage
### 𧊠Tilesets
For info on how to define and use tilesets, check out the [README](https://github.com/MrGVSV/bevy_tileset#-usage)
for `bevy_tileset`. This crate re-exports the entire crate under the `tileset` submodule.
To use this crate, make sure you add the following to your app:
```rust
use bevy::prelude::*;
use bevy_tileset_map::prelude::{TilesetPlugin, TilesetMapPlugin};
use bevy_ecs_tilemap::prelude::TilemapPlugin;
fn main() {
App::new()
// ...
// bevy_ecs_tilemap
.add_plugin(TilemapPlugin)
// bevy_tileset
.add_plugin(TilesetPlugin::default())
// bevy_tileset_map
.add_plugin(TilesetMapPlugin)
// ...
.run();
}
```
### đž Serialization/Deserialization
> With the `serialization` feature enabled
With this crate, serialization is very simple (as long as your tiles are generated using tilesets).
Simply add the `TilemapSerializer` to your system:
```rust
/// Assumes bevy_ecs_tilemap has already been properly setup to have tiles read from it
fn save_maps(serializer: TilemapSerializer) {
// This saves all currently generated maps
let maps = serializer.save_maps();
// Write to disk using something like serde_json...
}
```
And deserializing is just as simple:
```rust
/// Assumes bevy_ecs_tilemap has already been properly setup to have tiles placed into it
fn load_maps(mut serializer: TilemapSerializer) {
let path = FileAssetIo::get_root_path().join("assets/map.json");
let data = std::fs::read_to_string(path).unwrap();
let maps = serde_json::from_str::(&data).unwrap();
serializer.load_maps(&maps);
}
```
Check out
the [serialization](https://github.com/MrGVSV/bevy_tileset_map/blob/main/examples/serialization.rs)
example to see how we turn
some [JSON](https://github.com/MrGVSV/bevy_tileset_map/blob/main/assets/map.json) into a full
tilemap. Again, as long as you set everything up using tilesets, it should work pretty much as expected.
> Note: This feature is very barebones and partially experimental. If things aren't working like you want, feel free to submit an issue or PR about it!
### đ Placement/Removal
One of the nice features about this crate is that it provides some built-in tile placement/removal logic so you don't have to! This can easily be accessed using the `TilePlacer` system param.
```rust
fn place_tile(mut placer: Tileplacer, /* ... */) {
// ...
placer.place(
tile_id,
tile_pos,
map_id,
layer_id
);
}
```
Easy!
Plus it comes with other variants the `place` method (with all the same properties). So give them a try!
### đ§ Auto Tiling
While `bevy_tileset` adds the ability to define Auto Tiles, this crate actually puts it to use.
Using the aforementioned `TilePlacer` system parameter makes handling auto tiles a breeze! Besides simply handling the placement code, internally this handles multiple things related to auto tiles:
1. When placing a tile, it automatically inserts the required `AutoTile` component
2. If a tile needs to be removed and it's an auto tile, the removal process is also automatically taken care of
If you decide you want to do this manually, make sure you properly handle the placement/removal process. When placing you *must* add the `AutoTile` component (so the `AutoTiler` knows it exists). And when you remove an auto tile, make sure you send a `RemoveAutoTileEvent` event (otherwise surrounding auto tiles won't know to update).
Just remember that auto tiles can be _slow_, so thousands of them may result in lag when first placed (this can be mitigated by avoiding very large batch placements). However, once placed, they don't need to be updated anymore, so it shouldn't affect performance after that.
## đ Examples
Check out the [examples](https://github.com/MrGVSV/bevy_tileset#-examples) for `bevy_tileset` for tileset-specific
examples.
* [clickable](https://github.com/MrGVSV/bevy_tileset_map/blob/main/examples/clickable.rs) - Add and remove tiles using `bevy_ecs_tilemap`
and `bevy_tileset_map`
* [serialization](https://github.com/MrGVSV/bevy_tileset_map/blob/main/examples/serialization.rs) -
Load a tilemap from JSON
* [drag](https://github.com/MrGVSV/bevy_tileset_map/blob/main/examples/drag.rs) -
Click and drag to add or remove tiles
## đ Bevy Compatibility
| bevy | bevy_tileset_map |
|------|------------------|
| 0.7 | 0.5 |
| 0.6 | 0.4 |
| 0.5 | 0.2 |
## âšī¸ FAQ
#### Why is this not just a feature on bevy_ecs_tilemap or bevy_tileset?
The main reason for this is that those crates are meant to be generally used, whereas this one is meant to be more specific in usage: it's for those who want to use both crates together.