bevy_tileset 0.6.0

Simple, configurable tilesets in Bevy using RON
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95

//! # bevy_tileset
//!
//! > Simple, configurable tilesets in Bevy using RON.
//!
//! This crate provides a way for tilesets to be constructed at runtime either
//! manually in the code or automatically with configuration files.
//!
//! ## Usaage
//!
//! Simply __define__ your tiles and tilesets in config files:
//!
//! ```ron
//! // assets/tiles/my_tile.ron
//! (
//!   name: "My Tile",
//!   tile: Standard("textures/my_tile.png")
//! )
//! ```
//!
//! ```ron
//! // assets/my_tileset.ron
//! (
//!   name: Some("My Awesome Tileset"),
//!   id: 0,
//!   tiles: {
//!     0: "../tiles/my_tile.ron",
//!     // ...
//!   }
//! )
//! ```
//!
//! And __load__ it in via a system:
//!
//! ```
//! use bevy::prelude::*;
//! use bevy_tileset::prelude::*;
//!
//! fn load_tiles(asset_server: Res<AssetServer>) {
//!   let handle: Handle<Tileset> = asset_server.load("my_tileset.ron");
//!   // Store handle...
//! }
//! ```
//!
//! Then __access__ the generated tileset from anywhere:
//!
//! ```
//! use bevy_tileset::prelude::*;
//! fn my_system(tilesets: Tilesets, /* other system params */) {
//!
//!   let tileset = tilesets.get_by_name("My Awesome Tileset").unwrap();
//!   let tile_index = tileset.get_tile_index("My Tile").unwrap();
//!
//!   match tile_index {
//!     TileIndex::Standard(texture_index) => { /* Do something */ },
//!     TileIndex::Animated(start, end, speed) => { /* Do something */ },
//!   }
//! }
//! ```
//!
//! ## Crate Features
//!
//! * __`default`__ - No features automatically enabled
//! * __`variants`__ - Enables usage of Variant tiles
//! * __`auto-tile`__ - Enables usage of Auto tiles
//!

/// A re-export of `bevy_tileset_core` in case non-prelude modules are needed
pub use bevy_tileset_core as tileset;
/// A re-export of `bevy_tileset_tiles` in case non-prelude modules are needed
pub use bevy_tileset_tiles as tiles;

/// The main module to import when using this crate
///
/// # Examples
///
/// ```
/// use bevy_tileset::prelude::*;
/// ```
pub mod prelude {
	pub use bevy_tileset_core::prelude::*;
	pub use bevy_tileset_tiles::prelude::*;
}

/// A module containing code related to Auto Tiles
///
/// Only accessible with the `auto-tile` feature enabled
#[cfg(feature = "auto-tile")]
pub mod auto {
	pub use bevy_tileset_core::auto::*;
}

/// Module containing items for debugging
pub mod debug {
	pub use bevy_tileset_core::debug::*;
}