Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/virenbar/dynmapimageexport

CLI tool for downloading tiles from Dynmap HTTP server and merging them into one image.
https://github.com/virenbar/dynmapimageexport

cli-tool dynmap minecraft

Last synced: about 1 month ago
JSON representation

CLI tool for downloading tiles from Dynmap HTTP server and merging them into one image.

Host: GitHub
URL: https://github.com/virenbar/dynmapimageexport
Owner: Virenbar
License: mit
Created: 2022-10-02T17:04:52.000Z (over 2 years ago)
Default Branch: master
Last Pushed: 2024-10-24T15:20:31.000Z (2 months ago)
Last Synced: 2024-10-25T20:24:41.646Z (2 months ago)
Topics: cli-tool, dynmap, minecraft
Language: C#
Homepage:
Size: 10.6 MB
Stars: 19
Watchers: 3
Forks: 3
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # Dynmap Image Export [![Build artifact][build-src]][build-href]

CLI tool for downloading tiles from Dynmap HTTP server and merging them into one image.

![terminal](/assets/images/terminal.gif)

```text

.\DynmapImageExport   [arguments] [options]

Commands:

    a, about                              Show info about application

    list, ls                         Show available worlds and maps

    i, info              Show info about map

    m, merge      Merge dynmap to image [default: [0,100,0]]

Arguments:

        Dynmap URL

      World name

        Map name

      Point of map [x,y,z] [default: [0,100,0]]

Options:

    -p, --padding        Padding in tiles [all]|[vert,horz]|[top,right,bottom,left] [default: [2,2,2,2]]

    -z, --zoom              Zoom

    -o, --output          Output path

    -f, --format   Format

    -nc, --no-cache               Ignore cached tiles

    -t, --threads        Number of threads

    -t, --trace                   Write trace log

    -?, -h, --help                Show help and usage information

```

## Installation

* Install [.NET 6.x](https://dotnet.microsoft.com/download)

* Download [latest release](https://github.com/Virenbar/DynmapImageExport/releases)

## Usage

1. First see available worlds and maps

    ```text

    > .\DynmapImageExport list 

    Example:

    > .\DynmapImageExport ls https://map.minecrafting.ru/

    List for: https://map.minecrafting.ru/

    Available worlds and maps

    ├── world - Верхний мир

    │   ├── flat    Плоский

    │   └── se_view 3D юго-восток

    ...

    ```

2. Then available zoom levels

    ```text

    > .\DynmapImageExport info   

    Example:

    > .\DynmapImageExport i https://map.minecrafting.ru/ world flat

    Info for: https://map.minecrafting.ru/ - world - flat

    World: world - Верхний мир

    Map: flat - Плоский

    Perspective: iso_S_90_lowres PPB: 4

    Zoom levels

    ├── 0 - 4:1

    ├── 1 - 2:1

    ├── 2 - 1:1

    ├── 3 - 1:2

    ├── 4 - 1:4

    ├── 5 - 1:8

    └── 6 - 1:16

    ```

3. Make a image

    ```text

    > .\DynmapImageExport merge    [...] [options]

    Example:

    > .\DynmapImageExport m https://map.minecrafting.ru/ world flat [0,100,0] -p [6,6,5,5] -z 2

    ```

Used arguments:

* `https://map.minecrafting.ru/` - Dynmap HTTP server

* `world` - World name

* `flat` - Map name

* `[0,100,0]` - Minecraft coordinates of point.

* `-p [6,6,5,5]` - Padding in tiles from points. 6 to top, 6 to right, 5 to bottom, 5 to left.  

    This will produce 12x12 tiles image(1536x1536 in pixels)

* `-z 2` - Zoom level. 1:1 scale in this example.

### Notes

* Executing without arguments will launch in interactive mode

* Default zoom is 1:1 scale (i.e. 1 block to 1 pixel)

* Size of 10Kpx X 10Kpx image ~= 150MB; 20Kpx X 20Kpx ~= 450MB

## Points and Padding example

You can provide any number of points. They will be combined into a region. Padding will be added to the resulting region.

* `[2]` - 2 in each direction  

* `[2,3]` - 2 to top and bottom, 3 to right and left  

* `[2,3,2,2]` - 2 to top, 3 to right, 2 to bottom, 2 to left

  

One point with padding `[1,2,3,2]`  

![1 point](./assets/images/Point-1.svg)  

Three points with padding `[1]`  

![3 points](./assets/images/Point-3.svg)

## Image example

### Flat map

```console

.\DynmapImageExport m https://map.minecrafting.ru/ world flat [0,100,0] -p [6,6,5,5] -z 2

```

![flat](/assets/images/Minecrafting.ru-flat.png)

### Isometric map

```console

.\DynmapImageExport m https://map.minecrafting.ru/ world se_view [0,100,0] -p [5,11,5,10] -z 0

```

![se_view](/assets/images/Minecrafting.ru-se_view.png)

[build-src]: https://img.shields.io/github/actions/workflow/status/Virenbar/DynmapImageExport/build-artifact.yml?label=Build&logo=github

[build-href]: https://github.com/Virenbar/DynmapImageExport/actions/workflows/build-artifact.yml