Skip to main content

A Python library for reading and writing TMX files.

Project description

TMXpy

A Python library for reading and writing TMX files.

This library is fairly computer intensive, especially when rendering large maps. It is recommended to use a computer with decent specs when using this library.

Please note: This library only supports files saved with the CSV encoding.

Features

  • Rendering of TMX files to images
  • Replacing specific warps with other warps
  • Changing tiles of a TMX file
  • Adding tilesets to a TMX file

Installation

pip install tmxpy

Usage and Examples

from tmxpy import TMXpy
from pathlib import Path

tmx = TMXpy(sheets=[Path("path/to/tilesheet/directory")], path=Path("path/to/tmx/file"))
tmx.generateGIDDict()
tmx.renderAllLayers().save("path/to/output/image.png")

tmx.parseWarps()
tmx.replace_warp(0, {
    "map_x": 23,
    "map_y": 17,
    "destination": "Town",
    "dest_x": 10,
    "dest_y": 8,
})

tmx.setTile(23, 17, "129", layerName="Buildings")

Further examples can be found in the tests directory.

Development/Testing

  • Install dependencies with pip install -r requirements.txt
  • Tests can be added to tests/name_of_test.py and run with py -m tests.name_of_test
  • It can be built with py -m build

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

tmxpy-0.1.9.tar.gz (18.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

tmxpy-0.1.9-py3-none-any.whl (18.3 kB view details)

Uploaded Python 3

File details

Details for the file tmxpy-0.1.9.tar.gz.

File metadata

  • Download URL: tmxpy-0.1.9.tar.gz
  • Upload date:
  • Size: 18.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.2

File hashes

Hashes for tmxpy-0.1.9.tar.gz
Algorithm Hash digest
SHA256 ec593df766da0b97d495b5f821a94cf7d7c5d1c54cb29f5f2bfc59a5e8d45527
MD5 806eb1472545787fda2d0f1798eac3dd
BLAKE2b-256 132035f45e7ff1aee6441791354451e22269f3c045802595f59e0b0e5c43639c

See more details on using hashes here.

File details

Details for the file tmxpy-0.1.9-py3-none-any.whl.

File metadata

  • Download URL: tmxpy-0.1.9-py3-none-any.whl
  • Upload date:
  • Size: 18.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.2

File hashes

Hashes for tmxpy-0.1.9-py3-none-any.whl
Algorithm Hash digest
SHA256 e212de0ff6216d61ada19bd1658d8e426e9444e467dc6cad8a6e2050af572b31
MD5 9ab0b8184e531755f5ea01ad850660c5
BLAKE2b-256 6b03ba0e830b70831cf13a065eb90576081811de5a8595e51d2cedb075269e38

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page