Skip to content
Snippets Groups Projects
README.md 1.12 KiB
Newer Older
Matthew Hall's avatar
Matthew Hall committed
# rs-tiled
```toml
tiled = "0.9.5"
```
Matthew Hall's avatar
Matthew Hall committed

David M's avatar
David M committed
[![Rust](https://github.com/mapeditor/rs-tiled/actions/workflows/rust.yml/badge.svg)](https://github.com/mapeditor/rs-tiled/actions/workflows/rust.yml)
[![Crates.io](https://img.shields.io/crates/v/tiled.svg)](https://crates.io/crates/tiled)
Matthew Hall's avatar
Matthew Hall committed

A crate for reading TMX (map) and TSX (tileset) files from the [Tiled Map Editor](http://www.mapeditor.org/) into Rust.
It provides a huge set of features as well as a strong wrapper over internal features such as GIDs.
Matthew Hall's avatar
Matthew Hall committed

Documentation is available [on docs.rs](https://docs.rs/tiled/).
Matthew Hall's avatar
Matthew Hall committed

Code contributions are welcome as are bug reports, documentation, suggestions and criticism.
The minimum supported TMX version is 0.13.

Matthew Hall's avatar
Matthew Hall committed
### Example

```rust
use tiled::{FilesystemResourceCache, Map};
Matthew Hall's avatar
Matthew Hall committed

fn main() {
    let map = Map::parse_file(
        "assets/tiled_base64_zlib.tmx",
        &mut FilesystemResourceCache::new(),
    )
    .unwrap();
Kevin Balz's avatar
Kevin Balz committed
    println!("{:?}", map);
    println!("{:?}", map.tilesets()[0].get_tile(0).unwrap().probability);
Matthew Hall's avatar
Matthew Hall committed
}
Matthew Hall's avatar
Matthew Hall committed
```

### Licences
assets/tilesheet.png by [Buch](https://opengameart.org/content/sci-fi-interior-tiles)
Matthew Hall's avatar
Matthew Hall committed

Matthew Hall's avatar
Matthew Hall committed
Licenced under MIT