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

Uploaded Python 3

File details

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

File metadata

  • Download URL: tmxpy-0.1.5.tar.gz
  • Upload date:
  • Size: 17.4 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.5.tar.gz
Algorithm Hash digest
SHA256 0d0e5e668ac8d546e5c609e9f9b58546996f06768cee7261d6c15c218b4ded2d
MD5 008e50fb89038e98bcbbe219faf7a534
BLAKE2b-256 0cd997df83bb5c16c794295bdc5399136b7c2fdc47930701ff2c061c9eb49998

See more details on using hashes here.

File details

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

File metadata

  • Download URL: tmxpy-0.1.5-py3-none-any.whl
  • Upload date:
  • Size: 17.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.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 88bb02b7642148524a66075c22cebece8cc96fe069cc7cff7064914a9d748c31
MD5 e56e7f7b3fed71cac9f8c1e04a401512
BLAKE2b-256 74502ad721af6c8e7fa2bb8e604708400500c4c00d7224162266d0e9596a7fcf

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