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, though XML-encoded files can be converted with tmxpy.XMLtoCSV

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.2.5.tar.gz (18.5 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.2.5-py3-none-any.whl (18.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for tmxpy-0.2.5.tar.gz
Algorithm Hash digest
SHA256 a8d32a202d70c45590bc6f918a3f5d052875770d4b37903af3cc59add49807fe
MD5 ee7a405c67da149e1804d413f6e68626
BLAKE2b-256 054a8d4e60dadaaed9a4bd0dc35cb31bc0f2545a41d337227e6f367e3a82af5e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: tmxpy-0.2.5-py3-none-any.whl
  • Upload date:
  • Size: 18.5 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.2.5-py3-none-any.whl
Algorithm Hash digest
SHA256 859bb5be68069d34d66cde697d02be92e098c762fff7b5e8de3c285086b30c35
MD5 61858634fbc28e974afb31c48f25217b
BLAKE2b-256 c88e723f9b5ce187359a834cc77bac203155d9ef9fde5749fb663e3ce780b2cc

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