A lightweight C++14 parsing library for tmx map files created with the Tiled map editor

When I try to build my SFML project with tmxlite, I get the following error:

[email protected]:~/Documents/CPPGame/src$ make build-and-run 
g++ -c main.cpp
g++ main.o -o game -lsfml-graphics -lsfml-window -lsfml-system
/usr/bin/ld: main.o: warning: relocation against `_ZTVN3tmx11ObjectGroupE' in read-only section `.text._ZN3tmx11ObjectGroupD2Ev[_ZN3tmx11ObjectGroupD5Ev]'
/usr/bin/ld: main.o: in function `main':
main.cpp:(.text+0x117): undefined reference to `tmx::Map::Map()'
/usr/bin/ld: main.cpp:(.text+0x15c): undefined reference to `tmx::Map::load(std::__cxx11::basic_string<char, std::char_traits<char>, std::allocator<char> > const&)'
/usr/bin/ld: main.o: in function `tmx::Tileset::Tile::Tile()':
main.cpp:(.text._ZN3tmx7Tileset4TileC2Ev[_ZN3tmx7Tileset4TileC5Ev]+0x66): undefined reference to `tmx::ObjectGroup::ObjectGroup()'
/usr/bin/ld: main.o: in function `MapLayer::Chunk::ChunkArray::ChunkArray(sf::Texture const&, tmx::Tileset const&)':
main.cpp:(.text._ZN8MapLayer5Chunk10ChunkArrayC2ERKN2sf7TextureERKN3tmx7TilesetE[_ZN8MapLayer5Chunk10ChunkArrayC5ERKN2sf7TextureERKN3tmx7TilesetE]+0xe5): undefined reference to `tmx::Tileset::getLastGID() const'
/usr/bin/ld: main.o: in function `tmx::ObjectGroup::ObjectGroup(tmx::ObjectGroup const&)':
main.cpp:(.text._ZN3tmx11ObjectGroupC2ERKS0_[_ZN3tmx11ObjectGroupC5ERKS0_]+0x2b): undefined reference to `vtable for tmx::ObjectGroup'
/usr/bin/ld: main.o: in function `tmx::ObjectGroup::~ObjectGroup()':
main.cpp:(.text._ZN3tmx11ObjectGroupD2Ev[_ZN3tmx11ObjectGroupD5Ev]+0x13): undefined reference to `vtable for tmx::ObjectGroup'
/usr/bin/ld: warning: creating DT_TEXTREL in a PIE
collect2: error: ld returned 1 exit status
make: *** [Makefile:6: build-and-run] Error 1

The error suggests that it compiles okay, but there is an issue with linking.

Here is the snippet from my Makefile that I am using to compile and run my game:

	g++ -c main.cpp
	g++ main.o -o game -lsfml-graphics -lsfml-window -lsfml-system
	./game```
	
Is there something I have to change in the Makefile, or is the issue related to my code (I based the code off of the SFMLExample/main.cpp file).

Thanks

I'm getting the following errors upon building my project in Visual Studio:

..\include\tmxlite\map.hpp(98): error C2610: 'tmx::Map::Map(tmx::Map &&)' : is not a special member function which can be defaulted
..\include\tmxlite\map.hpp(99): error C2610: 'tmx::Map &tmx::Map::operator =(tmx::Map &&)' : is not a special member function which can be defaulted

Here are lines 98 and 99 of Map.hpp, respectively:

Map(Map&&) = default;
Map& operator = (Map&&) = default;

Are you able to provide some insight into why I'm getting these errors? Thank you!

Hey, I'm trying to install tmxlite but I'm not that experienced with adding multiple libraries to a project and making them all work together.

I added the tmxlite include to the Additional Include Directories, the "Debug Static" folder from the binaries to the Additional Library Directories and listed the libtmxlite-s-d.lib under additional dependencies.

I also added all the SFML Directories in the same way I usually add them to a project ( linked against the static debug libraries ).

I made a solution with a new project, added the main.cpp and SFMLOrthogonalLayer.hpp from the SFML example folder and tried to compile it.

However when I try to do that I get a bunch of linking errors, one of which I found especially suspicious : Error LNK2038 mismatch detected for 'RuntimeLibrary': value 'MDd_DynamicDebug' doesn't match value 'MTd_StaticDebug' in main.obj TmxLite

I tried changing the runtime library under code generation to MD_d but then I get it the other way around ! Error LNK2038 mismatch detected for 'RuntimeLibrary': value 'MTd_StaticDebug' doesn't match value 'MDd_DynamicDebug' in main.obj

Do you have any idea how I could solve this ? I think this might be the result of me linking the wrong kind of SFML/tmxlite files together but both the SFML libraries I linked and the tmxlite ones are static libraries. Any ideas what's going on ?

This should be pretty equivalent to the existing cmake files. Configuring is done normally as meson setup <path_to_tmxlite_source>, which will default to a release build, or passing -Dbuildtype=debug for a debug build. Other options are in meson_options.txt and are the same as the cmake ones, just lower case to match meson's style.

With this change tmxlite can be easily used as a subproject from other meson projects, ie: subproject('tmxlite')

If I call tmx::Layer::getLayerAs<tmx::something>() on a const tmx::Layer* I get infinite recursion in this line:

https://github.com/fallahn/tmxlite/blob/7872ea620ff00e2714f56970efb8c6537d7378f9/tmxlite/include/tmxlite/Layer.hpp#L98-L100

I believe that, if this is a const pointer, the overload shown above is selected ahead of the non-const version (line 91-92 of Layer.hpp) and it just calls itself without changing the type of any of the arguments. I suppose the intention was to call the non-const version which makes use of the template specializations in LayerGroup etc.

Here is an example program that shows it (using the platform.tmx file from ParseTest)

#include <tmxlite/LayerGroup.hpp>
#include <tmxlite/Map.hpp>
#include <tmxlite/ObjectGroup.hpp>
#include <tmxlite/TileLayer.hpp>

bool ok(tmx::Layer *lptr) {
  return lptr->getLayerAs<tmx::LayerGroup>().getVisible();
}
bool not_ok(const tmx::Layer *clptr) {
  return clptr->getLayerAs<tmx::LayerGroup>().getVisible();
}

int main() {
  tmx::Map map;

  if (map.load("maps/platform.tmx")) {
    auto first = map.getLayers().front().get();
    return ok(first) | not_ok(first);
  }
  return 0;
}

The "return bool" business is just to stop the compiler from optimizing out the call to getLayerAs. The not_ok call never returns, eventually fills the stack and crashes.

Hope that makes sense!

I'm using C++ Apple Clang 12.0.0

I am trying to use tmxlite for the first time and I keep getting this error:

LNK2019 unresolved external symbol _mz_inflateInit referenced in function "bool __cdecl tmx::decompress(char const *,class std::vector<unsigned char,class std::allocator > &,int,int)" (?dec[email protected]@@[email protected][email protected]@std@@@std@@[email protected])

I'm using Visual Studio 2017.

I am using the SFML example from the download:

#include <SFML/Graphics/RenderWindow.hpp>
#include <SFML/Window/Event.hpp>

#include <tmxlite/Map.hpp>

#include "SFMLOrthogonalLayer.hpp"

int main()
{
    sf::RenderWindow window(sf::VideoMode(800, 600), "SFML window");

    tmx::Map map;
    map.load("assets/demo.tmx");

    MapLayer layerZero(map, 0);
    MapLayer layerOne(map, 1);
    MapLayer layerTwo(map, 2);

    while (window.isOpen())
    {
        sf::Event event;
        while (window.pollEvent(event))
        {
            if (event.type == sf::Event::Closed)
                window.close();
        }

        window.clear(sf::Color::Black);
        window.draw(layerZero);
        window.draw(layerOne);
        window.draw(layerTwo);
        window.display();
    }

    return 0;
}

Can you explain a bit more in detail how to get it up and running with VS Community 2017?

Whenever I try to load any map, it crashes with the following error on Map map; map.load("map.tmx");: Unhandled exception at 0x749B08B2 in tmx.exe: Microsoft C++ exception: std::out_of_range at memory location 0x00739550. occurred Map loads and renders fine in the older sfml-tmxloader library. Running Visual Studio 2017 15.4.2 on Windows 10. Tried both using the pre-compiled binaries, compiled my own and included the source code directly, all crashes.

I'm trying to parse a map using tmxlite, and I'm having trouble with tilesets. This is my code:

const auto &tilesets = map.getTilesets();
for(const auto &tileset : tilesets)
{
    this->TilesetDump(tileset);
}


void Parser::TilesetDump(const tmx::Tileset tileset)
{
    std::vector<tmx::Tileset::Tile> tiles = tileset.getTiles();

    std::cout << "    Tileset: " << tileset.getName() << std::endl;
    std::cout << "        Tile count: " << (unsigned)tileset.getTileCount() << std::endl;
    std::cout << "        Tile count 2: " << (unsigned)tiles.size() << std::endl;
    std::cout << "        Image path: " << tileset.getImagePath() << std::endl;
    std::cout << "        First GID: " << (unsigned)tileset.getFirstGID() << std::endl;
    std::cout << "        Last GID: " << (unsigned)tileset.getLastGID() << std::endl;
}

This is the output:

    Tileset: greendale_interior
        Tile count: 0
        Tile count 2: 0
        Image path: /home/tim/projects/hawkthorne-journey/src/images/tilesets/greendale-interior.png
        First GID: 1
test-program: /home/tim/the-seed/projects/tmxlite/tmxlite/src/Tileset.cpp:229: uint32_t tmx::Tileset::getLastGID() const: Assertion `!m_tiles.empty()' failed.
Aborted

The image path is correct but for some reason I can't access the tiles. Is there something I need to do manually to load the image?

Two more proposals related to properties ^^

1. In the map.tmx, properties are in a std::vector but a real use case is a std::map<std::string, tmx::Property> (access by name). Is it possible to de something like that ? Should eventually manage the duplicate, but that's the only edge case I see.

2. Property do not has a constructor from C++ type. For my personal use for example, I store a map for property with default values but I must use workaround with a std::variant because Property can only be constructed from xml, I just replicate Property but with modiable content. Is it possible to support construction from float, int, std::string, etc ?

Thanks!

Worked perfectly with the same tmx file from version 1.3.x but crashes when saved with 1.4.0.

if (name == "tileset") { m_tilesets.emplace_back(m_workingDirectory); m_tilesets.back().parse(node, this); }

It crashes in the parse function.

This is a start for supporting the <group> tag added in version 1.0 of the TMX format. Let me know if my approach here doesn't make sense, or if I'm missing something major.

I ran the parse test and it seems to still be working, but I would like to update it to include nested layers within layer groups to make sure everything is functioning.

I add the tiled layer scrolling factor.

parallaxx: Horizontal parallax factor for this layer. Defaults to 1. (since 1.5)

parallaxy: Vertical parallax factor for this layer. Defaults to 1. (since 1.5)

Is it just me or is anyone else experiencing this issue? I'm on VS 19 Community Edition.

Severity	Code	Description	Project	File	Line	Suppression State	Detail Description
Error (active)	E0349	no operator "==" matches these operands	tmxlite_test	C:\Users\Rohan\source\repos\tmxlite_test\MapLayer.h	141
operand types are: const tmx::Tileset::Tile::Animation::Frame == tmx::Tileset::Tile::Animation::Frame


Severity	Code	Description	Project	File	Line	Suppression State
Error	C2678	binary '==': no operator found which takes a left-hand operand of type 'const tmx::Tileset::Tile::Animation::Frame' (or there is no acceptable conversion)	tmxlite_test	C:\Users\rohanharikr\source\repos\tmxlite_test\MapLayer.h	141	

It would be nice to be able to use externally installed miniz & pugixml, vendoring is bad for package managers (ODR violation).

• Move miniz & pugixml files in specific folders (vendor/miniz & vendor/pugixml for example)
• edit most cpp files with #include <pugixml.hpp> instead of #include "detail/pugixml.hpp" (this modification is tedious for package managers)
• Add 2 options in Meson & CMake files, like TMXLLITE_EXTERNAL_MINIZ and TMXLLITE_EXTERNAL_PUGIXML
• Depending on option values, inject vendored deps or find & inject external deps.

By default tmxlite uses fstream to open tmx files. As noted in #76 this does not work on android, the current work-around being loading the entire file into a string and passing to Map::loadFromString().

In #80 it is also noted that there is currently no support for zstd compressed maps as this requires including external dependencies.

The idea then is to create an API for tmxlite which allows a user to define a file loading mechanism of their choice. tmxlite itself could include file loading functions for android, for example, as well as optional file loaders for zstd and other potential sources such as PhysFS.

If anyone has any feedback on this idea, or ideas for API design, please comment! The current thinking would be similar to that of SFML's InputStream.

As mentioned in #70 from version 1.4.0 Tiled introduces zstd compression as an option for base64 encoded maps. tmxlite currently doesn't support the compression format as it cannot be decompressed by miniz.

The current fix is to switch the format of Tiled maps from zstd compression to zlib compression.