Skip to content

Latest commit

 

History

History
86 lines (66 loc) · 3.53 KB

README.md

File metadata and controls

86 lines (66 loc) · 3.53 KB
Raw

README

What is this repository for?

  • C++ loader and data structure for .tmx maps created by Tiled Map Editor.
  • Version 1.0.
  • Supports:
    • Tiled .tmx maps exported as XML
    • TileSets
    • Layers
    • Properties
  • Not-supported yet:
    • Objects
    • Terrain
    • Tile-flipping
    • Image layers

Using the code

  • Export your Tilemap using XML
  • The following code snippet shows how to get access to your map's data:
  • TMXLoader stores a collection of TMXMaps, so you can load a group of maps and access their data later as you please.
  • There is an included SDL demo showing how to use the library.
#!c++

TMXLoader* loader = new Loader();
loader->loadMap("testmap", "Assets/testmap.tmx"); 
loader->printMapData("testmap"); // prints map data to console, useful for debugging

loader->getMap("testmap"); // gets a map loaded and held by TMXLoader
loader->getMap("testmap")->getVersion();
loader->getMap("testmap")->getOrientation();
loader->getMap("testmap")->getWidth();
loader->getMap("testmap")->getHeight();
loader->getMap("testmap")->getTileWidth();
loader->getMap("testmap")->getTileHeight();
loader->getMap("testmap")->getBackgroundColourArray();
loader->getMap("testmap")->getRenderOrder();

loader->getMap("testmap")->getTileSet("defaulttileset")->getName();
loader->getMap("testmap")->getTileSet("defaulttileset")->getSource();
loader->getMap("testmap")->getTileSet("defaulttileset")->getFirstGID();
loader->getMap("testmap")->getTileSet("defaulttileset")->getLastGID();

loader->getMap("testmap")->getTileSet("defaulttileset")->getImageWidth();
loader->getMap("testmap")->getTileSet("defaulttileset")->getImageHeight();
loader->getMap("testmap")->getTileSet("defaulttileset")->getTileWidth();
loader->getMap("testmap")->getTileSet("defaulttileset")->getTileHeight();
loader->getMap("testmap")->getTileSet("defaulttileset")->getSpacing();
loader->getMap("testmap")->getTileSet("defaulttileset")->getMargin();
loader->getMap("testmap")->getTileSet("defaulttileset")->getOffsetX();
loader->getMap("testmap")->getTileSet("defaulttileset")->getOffsetY();
loader->getMap("testmap")->getTileSet("defaulttileset")->getTransparentColourArray();
loader->getMap("testmap")->getTileSet("defaulttileset")->getTileCount();
loader->getMap("testmap")->getTileSet("defaulttileset")->getProperty("property1");

loader->getMap("testmap")->getTileSet("defaulttileset")->getTile(1);
loader->getMap("testmap")->getTileSet("defaulttileset")->getTile(1)->getProperty("tileproperty1");

loader->getMap("testmap")->getTileLayer("Tile Layer 1")->getName();
loader->getMap("testmap")->getTileLayer("Tile Layer 1")->getWidth();
loader->getMap("testmap")->getTileLayer("Tile Layer 1")->getHeight();
loader->getMap("testmap")->getTileLayer("Tile Layer 1")->getTileVector();
loader->getMap("testmap")->getTileLayer("Tile Layer 1")->getProperty();

Usage

  • The library is provided under the MIT license, meaning you can use the code however you like for free, as long as you credit me and don't hold me liable to any problems you may have with the code. See License.txt in the source for more information.

  • The project makes use of RapidXML which also comes with the MIT license. See /TMXLoader/RapidXML/License.txt

Who do I talk to?

If you find the code useful, or have problems/suggestions I would love to hear from you.

Contributors