https://github.com/steffo99/lihzahrd
A Terraria world parser in Python
https://github.com/steffo99/lihzahrd
lihzahrd parser python37 terraria
Last synced: 6 months ago
JSON representation
A Terraria world parser in Python
- Host: GitHub
- URL: https://github.com/steffo99/lihzahrd
- Owner: Steffo99
- License: eupl-1.2
- Created: 2019-08-06T16:13:58.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-09-04T19:08:18.000Z (over 1 year ago)
- Last Synced: 2025-06-26T00:58:10.947Z (7 months ago)
- Topics: lihzahrd, parser, python37, terraria
- Language: Python
- Homepage: https://gh.steffo.eu/lihzahrd/html/
- Size: 13.2 MB
- Stars: 16
- Watchers: 1
- Forks: 8
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Lihzahrd
Terraria game world parser for Python
## Links
[](https://pypi.org/project/lihzahrd/)
[](https://gh.steffo.eu/lihzahrd/html/)
## Installation
Lihzahrd can be installed from PyPI like any other public Python package.
Using [uv](https://docs.astral.sh/uv/), that means:
```shell
uv add lihzahrd
```
## Usage
You can open a world file and get a `World` object by calling:
```python
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](http://gh.steffo.eu/lihzahrd/html/world.html).
> [!Warning]
>
> Maliciously designed Terraria worlds can drain system resources, crash the interpreter, or possibly do other evil things!
>
> **Make sure you trust worlds before parsing them!**
## Documentation
The documentation is available [here](https://gh.steffo.eu/lihzahrd/html/).
If you know something that is missing in the documentation, please let me know [with an issue](https://github.com/Steffo99/lihzahrd/issues/new)!
## PyPy
`lihzahrd` is compatible with [PyPy](https://www.pypy.org), 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!
### Benchmarks
Time to parse the same large world:
- CPython took 11.45 s.
- Pypy took 3.57 s!
### 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
- The [TEdit World Parser](https://github.com/TEdit/Terraria-Map-Editor/blob/master/TEditXna/Terraria/World.FileV2.cs), the most accurate source currently available.
- The [tModLoader wiki](https://github.com/tModLoader/tModLoader/wiki), containing lists of all possible IDs.
- The [Terrafirma world documentation](http://seancode.com/terrafirma/world.html), accurate for old worlds (version <69)
- The [1.3.x.x world documentation](http://ludwig.schafer.free.fr/), a bit incomplete, but an useful source nevertheless.
- A [JS World Parser](https://github.com/cokolele/terraria-world-parser/) on GitHub.
- A [Background Guide](https://steamcommunity.com/sharedfiles/filedetails/?id=841032800) on Steam that displays all possible world backgrounds.
## See also
- [flyingsnake](https://github.com/Steffo99/flyingsnake), a map renderer using this package