Skip to content
Snippets Groups Projects
Unverified Commit 789865ae authored by aleok's avatar aleok Committed by GitHub
Browse files

Merge pull request #122 from PieKing1215/readme

Start updating README.md
parents cd5200f2 487cc37b
No related branches found
No related tags found
No related merge requests found
# rs-tiled # rs-tiled
[![Travis](https://travis-ci.org/mattyhall/rs-tiled.svg?branch=master)](https://travis-ci.org/mattyhall/rs-tiled) [![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) [![Crates.io](https://img.shields.io/crates/v/tiled.svg)](https://crates.io/crates/tiled)
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/). 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/).
...@@ -10,7 +10,7 @@ Code contributions are welcome as are bug reports, documentation, suggestions an ...@@ -10,7 +10,7 @@ Code contributions are welcome as are bug reports, documentation, suggestions an
[There is a package on crates.io](https://crates.io/crates/tiled), to use simply add: [There is a package on crates.io](https://crates.io/crates/tiled), to use simply add:
``` ```
tiled = "0.9.3" tiled = "0.9.5"
``` ```
to the dependencies section of your Cargo.toml. to the dependencies section of your Cargo.toml.
...@@ -27,17 +27,8 @@ fn main() { ...@@ -27,17 +27,8 @@ fn main() {
} }
``` ```
### Things missing
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.
### Licences ### Licences
assets/tilesheet.png by Buch (http://blog-buch.rhcloud.com/) assets/tilesheet.png by Buch (https://opengameart.org/content/sci-fi-interior-tiles)
Licenced under MIT Licenced under MIT
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment