Skip to content
Snippets Groups Projects
README.md 1.3 KiB
Newer Older
Matthew Hall's avatar
Matthew Hall committed
# rs-tiled
Alejandro Perea's avatar
Alejandro Perea committed
tiled = "0.10.2"
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)
[![dependency status](https://deps.rs/crate/tiled/0.10.2/status.svg)](https://deps.rs/crate/tiled/0.10.2)
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
Alejandro Perea's avatar
Alejandro Perea committed
use tiled::Loader;
Matthew Hall's avatar
Matthew Hall committed

fn main() {
Alejandro Perea's avatar
Alejandro Perea committed
    let mut loader = Loader::new();
    let map = loader.load_tmx_map("assets/tiled_base64_zlib.tmx").unwrap();
Kevin Balz's avatar
Kevin Balz committed
    println!("{:?}", map);
    println!("{:?}", map.tilesets()[0].get_tile(0).unwrap().probability);
Alejandro Perea's avatar
Alejandro Perea committed
    
    let tileset = loader.load_tsx_tileset("assets/tilesheet.tsx").unwrap();
    assert_eq!(*map.tilesets()[0], tileset);
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