mirror of https://github.com/Steffo99/flyingsnake.git synced 2024-12-22 06:34:18 +00:00

CLI Terraria world map renderer https://forums.terraria.org/index.php?threads/flyingsnake-a-world-map-renderer.82400/

Find a file

Stefano Pigozzi 8cb0f522db Allow a better layer selection		2019-08-27 18:48:35 +02:00
flyingsnake	Allow a better layer selection	2019-08-27 18:48:35 +02:00
.gitignore	Allow a better layer selection	2019-08-27 18:48:35 +02:00
LICENSE.txt	First commit	2019-08-19 20:49:56 +02:00
README.md	Allow a better layer selection	2019-08-27 18:48:35 +02:00
requirements.txt	First commit	2019-08-19 20:49:56 +02:00
setup.py	Change description and bump version	2019-08-19 20:55:15 +02:00

README.md

`flyingsnake`

Generate Terraria world maps with this easy to use command line utility!

Requirements

To use flyingsnake, you need Python 3.7 or higher installed on your machine.

Installing

flyingsnake is available on PyPI, so you can download it through pip.

Just enter this in your terminal:

pip install flyingsnake

Usage

To create a basic world map named Output.png from the Small_Example.wld file present in your current working directory, run in your terminal:

python3.7 -m flyingsnake Small_Example.wld Output.png

Layers

The world map is generated by merging together multiple layers that can be enabled/disabled through flags.

In order, those are:

Background
Walls
Liquids
Blocks
Wires

Background

The background layer is made by coloring the Overworld, the Underground and the Caverns their respective background color.

It can be selected with the --background flag, or turned off with the --no-background flag.

Walls

The walls layer contains the colors of the walls present in the world.

It can be selected with the --walls flag, or turned off with the --no-walls flag.

Liquids

The liquids layer contains the colors of the liquids present in the world (water, lava, honey...)

It can be selected with the --liquids flag, or turned off with the --no-liquids flag.

Blocks

The blocks layer contains the colors of the blocks present in the world.

It can be selected with the --blocks flag, or turned off with the --no-blocks flag.

Wires

The wires layer is a semi-transparent overlay of the wires present in the world.

It can be selected with the --wires flag, or turned off with the --no-wires flag.

Custom colors

Different colors can be specified by passing the --colors file.json option to the command.

You can see an example color file here; the colors are in RGBA format, and go from 0 to 255.

If no custom colors are passed, the script will use the default TEdit colors (defined in settings.xml).

License

flyingsnake 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 flyingsnake.