Hel Tiled

Wrapper for utilizing Tiled maps in C#. Created for the Hel Engine.
Explore the docs »
API Reference . Tiled · Report Bug · Request Feature

Table of Contents

• About the Project
• Getting Started
  • Installation
• Usage
• Roadmap
• Contributing
• License
• Contact

About The Project

Hel.Tiled is a completely decoupled Tiled map loader. Although Hel.Tiled is used in Hel.Engine, you can use it with any framework you want.

Hel.Tiled is not currently stable.

Highest tested TILED version: 1.4.2

Hel.Tiled currently only supports JSON files

Getting Started

Hel.Tiled is available on the NuGet package manager

Installation

Add Hel.Tiled to your project, or build is locally.

Usage

Full release documentation

Usage depends on if this library is being used on its own or through Hel.Engine.

Hel.Engine usage

Using Hel.Tiled in Hel.Engine is very simple.

// Call the static tilemap loader in Hel.Engine and pass the path to your json file
// stored in Content.
var tilemap = TiledLoader.TilemapLoader("myFile.json");

You can now use the tilemap object. This will also load the proper textures.

Hel.Tiled usage

// Call the tilemap loader
var tilemap = TiledFactory.LoadTilemap(@"path/to/file.json");

This will load the tilemap and its tilesets. Tileset textures will NOT be loaded however.

Roadmap

See the open issues for a list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

License

Distributed under the MIT License. See LICENSE for more information.

Contact

Lorenzo Torelli - @twitter_handle - lorenzo@tortonmind.com