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

Uploaded Python 3

File details

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

File metadata

  • Download URL: tmxpy-0.1.8.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.8.tar.gz
Algorithm Hash digest
SHA256 74d003912bbbb2da708c66189cf98993d8ec5805c3cfd0740f8dd6c8cf1ee287
MD5 173b413a84f15f683afbde50ab1f432c
BLAKE2b-256 6c721306a5661a35de894b26c75302c974508f70924eb8a02536039c18f4387f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: tmxpy-0.1.8-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.8-py3-none-any.whl
Algorithm Hash digest
SHA256 f97d63e75587b7c3766d54e462d9f84d6aeaca011455a861c3411374d7cadaee
MD5 64f0c34d40b283aa89a884aed78d3364
BLAKE2b-256 e7df0eb57e46a65a628df36d96ae4d8bba1b3cdee354d817b9f76639e1d10320

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