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.1.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.2.1-py3-none-any.whl (18.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: tmxpy-0.2.1.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.2.1.tar.gz
Algorithm Hash digest
SHA256 18ab4f831686c43b655abcdcbf58590f87c2ee0b1db70b3d9932fb22f142f3d3
MD5 f0257db2c5401fc2b3f806fde3e2b868
BLAKE2b-256 3e059d8ad69c742d23ac81ef00a629aa9937aac4632998dc325f2c1b94524c6e

See more details on using hashes here.

File details

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

File metadata

  • Download URL: tmxpy-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 18.4 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 b4cf4f9ed765e89e156099b9f6e1ab2be3d4c37eee5b2b2c48177c0e329fc04c
MD5 e1f6fd88f8f28e4728f891d18eed7f90
BLAKE2b-256 4fbafa7b8c5253539eb86dcb0ce43b8011e934e303a70cd886b2fda5df23e1aa

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