mirror of https://github.com/Steffo99/lihzahrd.git synced 2024-10-16 06:27:29 +00:00

Terraria world parser in Python

Find a file

Stefano Pigozzi 7f229490b8 Optimize a few functions... I think.		2020-06-10 19:52:57 +02:00
.github/workflows	Update pythonpackage.yml	2019-08-13 00:00:36 +02:00
docs	Update docs	2020-06-10 19:52:57 +02:00
docs_source	Improve tile repr	2020-04-17 17:03:12 +02:00
lihzahrd	Optimize a few functions... I think.	2020-06-10 19:52:57 +02:00
.gitattributes	Update git data	2019-08-07 14:08:25 +02:00
.gitignore	Update to 1.0b2	2019-08-20 16:12:38 +02:00
__main__.py	Change error message	2020-06-10 19:52:57 +02:00
LICENSE.txt	Create LICENSE.txt	2019-08-13 17:06:24 +02:00
README.md	Update README.md	2020-05-25 20:23:00 +02:00
requirements.txt	Add sphinx to the requirements	2020-06-10 19:52:57 +02:00
setup.py	Bump the version number to 2.0a1	2020-06-10 19:52:57 +02:00

README.md

`lihzahrd`

Doesn't currently support Terraria 1.4!

A Terraria 1.3.5.3 world parser in Python.

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

Install with:

pip install lihzahrd

Usage

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.

Documentation

The documentation is available here.

It's a bit messy and incomplete, as I still have not figured out the meaning of some data, and the code is in need of some refactoring.

If you know something that isn't present in the documentation, please let me know with an issue!

References used

The TEdit World Parser, the most accurate source currently available.
The tModLoader wiki, containing lists of all possible IDs.
The Terrafirma world documentation, accurate for old worlds (version <69)
The 1.3.x.x world documentation, a bit incomplete, but an useful source nevertheless.
A JS World Parser on GitHub.
A Background Guide on Steam that displays all possible world backgrounds.

PyPy

lihzahrd is compatible with PyPy, a faster implementation of 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!

Benchmarks

Time to parse the same large world:

CPython took 11.45 s.
Pypy took 3.57 s!

License

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.