Skip to main content

A Terraria world parser in Python

Project description

lihzahrd Available on PyPI

A Terraria world parser in Python.

You can use this package to get programmer-friendly data from a Terraria world!


Use your favourite Python package manager to install lihzahrd:

  • Venv + Pip

    $ source .venv/bin/activate
    $ pip install lihzahrd
  • Poetry

    $ poetry add lihzahrd
  • And more!


You can open a world file and get a World object by calling:

import lihzahrd
world = lihzahrd.World.create_from_file("filename.wld")

It will take a while to process: a small Terraria world contains more than 5 million tiles!

Once you have a World object, you can use all data present in the save file by accessing its attributes.


Loading maliciously designed Terraria worlds can drain system resources, crash the interpreter, or possibly do more evil things!

Make sure you trust the worlds you are parsing!


The documentation is available here.

If you know something that is missing in the documentation, please let me know with an issue!


lihzahrd is compatible with PyPy, an alternative implementation on Python!

If you think that parsing a world takes too much time, you can use PyPy to reduce the required time by a factor of ~3!


Time to parse the same large world:

  • CPython took 11.45 s.
  • Pypy took 3.57 s!


To contribute to lihzahrd, you need to have Poetry installed on your PC.

After you've installed Poetry, clone the git repo with the command:

$ git clone

Then enter the new directory:

$ cd lihzahrd

And finally install all dependencies and the package:

$ poetry install

This will create a new virtualenv for the development of the library; you can activate it by typing:

$ poetry shell

Please note that for compatibility with PyPy, the project needs to target Python 3.6.

Building docs

You can build the docs by entering the docs_source folder and running make html, then committing the whole docs folder.

References used


lihzahrd is licensed under the AGPL 3.0. That means you have to publish under the same license the source code of any program you create that uses lihzahrd.

See also

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

lihzahrd-3.1.0.tar.gz (100.5 kB view hashes)

Uploaded Source

Built Distribution

lihzahrd-3.1.0-py3-none-any.whl (118.4 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page