Skip to content
Snippets Groups Projects
README.md 1.47 KiB
Newer Older
Matthew Hall's avatar
Matthew Hall committed
# rs-tiled

[![Travis](https://travis-ci.org/mattyhall/rs-tiled.svg?branch=master)](https://travis-ci.org/mattyhall/rs-tiled)
[![Crates.io](https://img.shields.io/crates/v/tiled.svg)](https://crates.io/crates/tiled)
Matthew Hall's avatar
Matthew Hall committed

Read maps from the [Tiled Map Editor](http://www.mapeditor.org/) into rust for use in video games. It is game engine agnostic and pretty barebones at the moment. 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.

[There is a package on crates.io](https://crates.io/crates/tiled), to use simply add:
Matthew Hall's avatar
Matthew Hall committed

```
Matthew Hall's avatar
Matthew Hall committed
tiled = "0.9.3"
Matthew Hall's avatar
Matthew Hall committed
```

to the dependencies section of your Cargo.toml.
Matthew Hall's avatar
Matthew Hall committed
### Example

```rust
extern crate serialize;
extern crate tiled;

use std::fs::File;
use std::io::BufReader;
use std::path::Path;

Matthew Hall's avatar
Matthew Hall committed
use tiled::parse;

fn main() {
    let file = File::open(&Path::new("assets/tiled_base64_zlib.tmx")).unwrap();
    println!("Opened file");
    let reader = BufReader::new(file);
    let map = parse(reader).unwrap();
Kevin Balz's avatar
Kevin Balz committed
    println!("{:?}", map);
    println!("{:?}", map.get_tileset_by_gid(22));
Matthew Hall's avatar
Matthew Hall committed
### Things missing
Matthew Hall's avatar
Matthew Hall committed
There are a few things missing at the moment:

- Terrain
- Tile flipping
- Image layers
- A nice API. At the moment you can access attributes and properties, find tilesets by GID and loop through the tiles. This leaves a user of the library with a bit to do.
Matthew Hall's avatar
Matthew Hall committed

Matthew Hall's avatar
Matthew Hall committed
### Licences
Matthew Hall's avatar
Matthew Hall committed
assets/tilesheet.png by Buch (http://blog-buch.rhcloud.com/)

Matthew Hall's avatar
Matthew Hall committed
Licenced under MIT