mirror of https://github.com/Steffo99/flyingsnake.git synced 2024-10-16 06:27:34 +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 4d26a53e87 Update to 1.4; some colors are still missing, though		2020-06-11 01:09:28 +02:00
flyingsnake	Update to 1.4; some colors are still missing, though	2020-06-11 01:09:28 +02:00
.gitattributes	Add integration test	2019-09-28 22:32:02 +02:00
.gitignore	Merge branch 'fs-1' of https://github.com/polandar/flyingsnake into polandar-fs-1	2019-10-02 10:56:06 +02:00
flyingsnake-completion.bash	Add Bash completion	2019-10-05 18:56:03 +02:00
LICENSE.txt	First commit	2019-08-19 20:49:56 +02:00
poetry.lock	Update to 1.4; some colors are still missing, though	2020-06-11 01:09:28 +02:00
pyproject.toml	Update to 1.4; some colors are still missing, though	2020-06-11 01:09:28 +02:00
README.md	Add maintenance badge	2020-03-21 02:49:34 +01:00

README.md

`flyingsnake`

Render 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 and inside your PATH.

Installing

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

Windows

Open either Windows PowerShell (Windows 10) or the Command Prompt (other Windows versions) and enter:

pip install flyingsnake --upgrade

Linux

Enter this in your terminal:

python3.7 -m pip install flyingsnake --upgrade

Usage

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

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 exclusively 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 exclusively with the --walls flag, or turned off with the --no-walls flag.

If the walls are painted, they will be colored with the paint color. You can turn off paint colors with the --no-paints option.

Liquids

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

It can be selected exclusively 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 exclusively with the --blocks flag, or turned off with the --no-blocks flag.

If the blocks are painted, they will be colored with the paint color. You can turn off paint colors with the --no-paints option.

Wires

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

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

Custom colors

By default, flyingsnake uses the colors defined in the TEdit settings file.

However, you can use different colors by passing the --colors colors.json option to the command.

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

License

flyingsnake is licensed under the AGPL 3.0. Basically, you're allowed to do whatever you want with this program, but you have to publish all modified code, and it has to be published under the same license.