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

Uploaded Python 3

File details

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

File metadata

  • Download URL: tmxpy-0.2.6.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.6.tar.gz
Algorithm Hash digest
SHA256 ce48eaf9855ed9d284ae6932581626a39e58aee5ffa7ff594ff275c0ae70ad29
MD5 bbc1a72c1fcb320df8a140cf95933606
BLAKE2b-256 24eb971e8b4006c03da08e08571b15d49c4c6ed66789858a0670d012063fc0eb

See more details on using hashes here.

File details

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

File metadata

  • Download URL: tmxpy-0.2.6-py3-none-any.whl
  • Upload date:
  • Size: 18.6 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.6-py3-none-any.whl
Algorithm Hash digest
SHA256 ff3bdce58e057ff8106be82c8becb13039b0c7129a29e7858846c0bd7e7c1eb1
MD5 5840450921ccf006022e110b1c2684b4
BLAKE2b-256 df05a75572d417342433be5bf82263ff745b224633efe2b393ece61cccfb4866

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