Swift framework for working with Tiled assets in SpriteKit

How can I intercept the end of the map loading without completions or delegate if my code follow your home instructions? How can I use callbacks?

// Load TileMap
guard let tilemap = SKTilemap.load(fromFile: currentTMXfilename) else {
            fatalError("Failed to load tilemap.")
}

after this line if I try to get a SKLayer, is always nil (I suppose because the map don't finish to load all components..) .. Thank you in advance.

Whenever I try to leave my class that inherits SKTiledScene using view.presentScene() and then display the tile map again, memory isn't released when it should be. A simple example is using your demo iOS project: switching between the various tilemaps increases the memory even when I go back to the first one, which will eventually result in a crash. I'm suspecting that there's a strong reference cycle in SKTiledScene that's stopping the tilemap from being deallocated, but I can't find it myself. Any help would be greatly appreciated!

First of all, great work on this project! I think generally it's easy to use. I forked a branch for tvOS and perhaps I will in the future submit a patch, if I can adapt the Demo project properly for tvOS.

Now for my question ...

In my current level setup I have to following:

• I have created a tile map that makes use of a tile set.
• The tile set contains some objects with sprites.
• I have created Object Types using the Object Types Editor. One of these Object Types is a "Creature". As a property for "Creature" I have added "breed".
• Within the tile set I assigned the type "Creature" to the tiles. I've set the "breed" property to "player" for 1 tile and "imp" to another tile.

Now it is difficult for me to read this property directly using the SKTiled framework. It seems I have to resort to a bit of "hackery" to read the value for "breed". Currently I do this as follows:

        if let tile = object.value(forKeyPath: "tile") as? SKTile {
            if let breed =  tile.tileData.stringForKey("breed") {
                print("breed: \(breed)")
            }
        }

The "hackery" in this situation is the fact that I use value(ForKeyPath:) to access to tile property, in order for me read the value for the breed property.

I don't know if it's a good idea to make the tile property publicly accessible, but I would like to have some cleaner way to access these kind of properties.

Perhaps I am doing something wrong or perhaps this is an area where the framework could improve.

Hello Michael, seems that sometimes the actual framework (v.1.07) crash with the message on subject. The crash is stopped to appDelegate so there isn't a specific line of code, but during my analisys to the debug error output, I've discovered the array layers is involved when the tileLayers are in paused mode. So I've change this code:

SKTiledMap.swift (original)

/// Pauses the node, and colors all of its children darker.
    override open var isPaused: Bool {
        didSet {
            guard oldValue != isPaused else { return }
            let newColor: SKColor = isPaused ? SKColor(white: 0, alpha: 0.25) : SKColor.clear
            let newColorBlendFactor: CGFloat = isPaused ? 0.2 : 0.0
            
            speed = isPaused ? 0 : 1.0
            color = newColor
            
            layers.forEach { layer in
                layer.color = newColor
                layer.colorBlendFactor = newColorBlendFactor
                layer.isPaused = isPaused
                //layer.speed = speed
            }
        }
    }

with this code:

 /// pauses the node, and colors all of its children darker.
    override open var isPaused: Bool {
        didSet {
            guard oldValue != isPaused else { return }
            let newColor: SKColor = isPaused ? SKColor(white: 0, alpha: 0.25) : SKColor.clear
            let newColorBlendFactor: CGFloat = isPaused ? 0.2 : 0.0
            
            speed = isPaused ? 0 : 1.0
            color = newColor
            let tempLayers:Set<TiledLayerObject> = layers
            tempLayers.forEach { layer in
                layer.color = newColor
                layer.colorBlendFactor = newColorBlendFactor
                layer.isPaused = isPaused
                //layer.speed = speed
            }
            layers = tempLayers
        }
    }

where I've found a workaround ,I've created a temporary array to avoid enumeration to the original..

I've found also this file:

SKTileLayer.swift

override open var isPaused: Bool {
        didSet {
            tiles.forEach { tile in
                tile?.color = self.color
                tile?.colorBlendFactor = self.colorBlendFactor
            }
        }
    }

where I've maded:

override open var isPaused: Bool {
        didSet {
            let tempTiles:TilesArray = tiles
            tempTiles.forEach { tile in
                tile?.color = self.color
                tile?.colorBlendFactor = self.colorBlendFactor
            }
            tiles = tempTiles
        }
    }

On Xcode 12 - M1Mac i have trouble to set this Framework up as described. with Carthage I get this error:

Building universal frameworks with common architectures is not possible. The device and simulator slices for "SKTiled" both build for: arm64 Rebuild with --use-xcframeworks to create an xcframework bundle instead.

cocoapods doesn't work either.

on Xcode 13 beta5 I tried to add the Framework directly via "File->Add Package" and pasted the GitHub link - still no luck, it was unable to resolve dependencies

im new to Xcode/iOS please update install instructions for this framework

I've a map maked with "Tiled Map Editor" version 1.4.2 and all is perfect using this editor. When I try to load all map and assets inside my game, strange things happened during the loading of tiles taken by tilesets based on tilesets image (multiple tiles in one big image). It seems the ID taken is the previous in the tile sequence, so instead of showing TILE ID 4, SKTiled show ID 3.

I was searching for the exact responsible method and I've found it:

public func getLocalID(forGlobalID gid: Int) -> Int {
        // firstGID is greater than 0 only when added to a tilemap
        let id = (firstGID > 0) ? (gid - firstGID) : gid
        // if the id is less than zero, return the gid
        return (id < 0) ? gid : id
    }

if I change this line the tilesets based on tilesets showed correctly all tiles, but the rest of the map is total black let id = (firstGID > 0) ? (gid - firstGID) + 1 : gid

Any idea about it? Could I distinguish tilesets based on tilesets from traditional tilesets to apply a condition and solve it?

Thank you in advance for all your support.

After the map is loaded, some elements on the map need to perform interaction after the user clicks, such as jumps, bubbles, etc.

Is this feature currently supported?

I'm testing out this library as a possible means to load in default maps and manage maps for a biz sim game. The MacOS demo application seemed to work OK with the sample tilemaps.

I tried loading in my own tilemap (50x50 at 64px), sometimes it loads fine, but others it only loads to y31 graphically. I can still see the mouse over triggers change for the lower part of the image, even though I can't see it. When i click "show grid", this then changes so only x18 and beyond are shown, but all of y is shown.

Seems pretty weird to me. It's an intermittent issue, so it seems. (I'm sorry.) Here are the attached tilemap and pallet file.

tileset.zip (I had to upload them as a zip because of github restrictions.)

I don't want to spend time intergrating this tilemap solution into my current setup if there are problems with maps of that size.

I'm running version 1.21. Running on MBP 13" 2017 on MacOS 10.13.6

Hey,

When i try to install 1.12 version i get this error :

[!] Unable to satisfy the following requirements:

- `SKTiled (~> 1.12)` required by `Podfile`

None of your spec sources contain a spec satisfying the dependency: `SKTiled (~> 1.12)`.

You have either:
 * out-of-date source repos which you can update with `pod repo update` or with `pod install --repo-update`.
 * mistyped the name or version.
 * not added the source repo that hosts the Podspec to your Podfile.

Note: as of CocoaPods 1.0, `pod repo update` does not happen on `pod install` by default.

I searched at cocoapods.org and the version number was 1.07

When i change my podfile to SKTiled (~> 1.07) it works.

Hi, first of all thank you for the amazing framework! It's really hard to find stuff on tile maps in swift, so this framework really helps.

I'm trying to use layer.addTileAt to change a tile at a coordinate, but I'm running into an issue. Calling that function removes the tile, but it doesn't replace the tile with a new one. For example, downloading your repo and adding this line of code on line 450 of SKTiled/Demo/SKTiledDemoScene.swift after updatePropertiesInfo():

let newTile = (tilemap.getLayers(named: "Ground")[0] as? SKTileLayer)?.addTileAt(coord: coord, gid: 41)

Should change the tile to a new tile with gid 41 (I think this corresponds to a wall tile?) but it only removes and doesn't replace the tile. I tested this on the isometric (second) map. It seems to return the proper wall tile but it isn't visible, but I couldn't figure out how to fix this issue.

Any help would be greatly appreciated!

To get this to build in iOS 11, I had to remove the zlib module included in the repository and add OTHER_LDFLAGS = "-lz"; to the project.

When I started with your framework I noticed that everything worked fine except that some of my nodes disappeared only when SKTiled was imported for the first time.

After hours of investigation, I noticed that you added a convenience init to SKColor and since I was using the classical range of alpha value, your init was overriding the UIColor one and making my colored sprites with an alpha value near 0.

When presenting a new scene it appears not all memory is freed.

The Demo project shows this, when repeatedly pressing "next" cycling through the maps, memory usage goes up, and never down. On the iOS Simulator I see ± 1MB increased memory used each time, on macOS I see ±5MB of increased memory use each time. The memory graph never goes down.

When trying my own app, with a single TMX file (eg. the famous level1.tmx file from this example) I get 100 MB (!) of increased memory use on macOS and 2 MB on iOS Simulator every time a new SKTiledScene is presented with that map.

When trying with an empty TMX map of size 10x10 tiles with no content, I get 120 MB of increased memory use on macOS and 0.2 MB on iOS Simulator every time a new SKTiledScene is presented.

It appears to me that on macOS the problem is huge, on iOS it is doable

The SKTiledScene.deinit gets called each time so the scene is cleaned up correctly (I think?)

When debugging with Xcodes memory graph it shows no problems or leaks. However, if I don't load a map with SKTiledScene.setup(....) the issue does not occur.

When I override deinit in all classes and print a debug text, I can see that only SKTilemapParser gets deinited immediately after loading the map. All other classes are never deinited.

While it is easy to get the tiles using tileAt(coord: tileCoord) from the SKTilemap or SKTileLayer, there is no reverse method that gives me the coords for any given SKTile.

I would like to be able to get the coords from the SKTile itself.

(I could calculate them myself my using something like tilemap.coordinateForPoint(tile.position) but that seems complicated and may not be accurate depending on the parent node of the tile.)

thanks

Thanks for maintaining this awesome project!

As a new game dev, I'm looking for some information:

• player / enemies: do I add them as children on the SKScene, on the world node, on the tilemap, or on a layer? • collision detection: as collision objects are not supported in SKTiled, should I add SpriteKit collision masks to all tiles and didBegin(_ contact:), or for example check for the presence of tiles near the player position?

Thanks!

Hi there!

First of thanks for this amazing project, it's very useful and nicely built. Having the ability to import tmx files straight into SpriteKit is incredibly valuable :)

I have some question though. I am working on a new project, and setting up the toolset. One of the main challenges I see is that I want to be able to render quite large maps (eg 300300tiles) without loading screens etc. The tiles are 3232, but that is not really important now. I preferably design the maps in Tiled, though that is not a must.

Now I tried two API's to draw large tile maps having 90K tiles. I tried SKTiled, and I really liked the easiness of putting a tmx map in there and it works OOTB. But I found that the performance is not optimal, which I sort of expected with SpriteKit having to take care of 90K nodes, even though not all are rendered ofc. Especially tile cracking is an issue, which I couldn't resolve with the proposed actions here. Enabling shouldEnableEffects also didn't really help, as the map is larger than the max framebuffer texture size is exceeded in my case, making parts of the map being cropped out.

I gave SKTileMapNode a shot as well. This has an obvious downside, being that built-in Xcode map editor is quite a mess. But drawing the map does result in only 1 node being drawn, instead of 90K. Moreover, the tile cracking isn't an issue as well.

So I conclude out of this that the usability of SKTiled greatly exceeds that of the SKTileMapNode and related API's and map building capabilities. But, the performance optimizations of SKTileMapNode are probably not to be matched. Hence, I wonder if it might be possible to use tmx files, post process them in some way, and as a result have a SKTileMapNode being produced, either fully in code or as .sks file. Possible it probably is, whether its worth the effort that yet remains to be uncovered. But before I loose myself in this problem, what are your thoughts on this, and did you ever consider the same for example?

Sorry to create an issue for this, I couldn't find another way to reach out to you.

Cheers,

Sander

I heavily rely on the scaling objects in ObjectsLayer inside Tiled. now all object-scaling seems to be ignored by SKTilemap .. that's really unfortunate - all my map layout is broken that way is there a fix / workaround for that?