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

Uploaded Python 3

File details

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

File metadata

  • Download URL: tmxpy-0.2.4.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.4.tar.gz
Algorithm Hash digest
SHA256 3513cf2b56734ef34bbac7fa51f4f0970dbab65dc98301cc18453fe06a574254
MD5 2b1e435018978a0756174b4d57c49fbb
BLAKE2b-256 7db0956af062784093d4de6c04595b61624737edfa11558ccfcc5e8d9004ae6d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: tmxpy-0.2.4-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.4-py3-none-any.whl
Algorithm Hash digest
SHA256 e92489d13a635c0967e76968aa08f78c42963539c4740fae2ab56b4267183fe1
MD5 0a15f8dc19c74a91fc0a3656e7590f05
BLAKE2b-256 94dce9f47a6e233dd6b5897db8d545f6372d6f14859e0c54e27a1bad0e088c0c

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