/ArtMapMapImage

Map image pixels for use in Minecraft's ArtMap plugin.

Primary LanguagePythonGNU General Public License v3.0GPL-3.0

Readme Card


DISCLAIMER

This Python program is compiled with a non-commercial version of Nuitka and therefore can be flagged as a false-positive in anti-virus/malware tools. All source and build files are available for scrutiny by the public here at this repository and anyone who can look can see there are no external resources being inserted at build time. Everything at this repository is stored and built here and all logs are available for every action taken.

More information about Nuitka being flagged can be found here:

https://nuitka.net/user-documentation/common-issue-solutions.html#windows-virus-scanners


About

This is part of a "ArtMap Suite" of tools for which the root of the project can be found here:

https://github.com/Lateralus138/ArtMapSuite

Description

ArtMap Map Image (am_mapimage) is a command line tool created specifically for the Minecraft plugin "ArtMap". This tool reads and returns the hexadeciaml color values of each pixel of an image.

While this tool can be used by itself it is best used with the first tool in this suite called 'ArtMap Closest'. You would read the pixel colors with this tool and then feed the results to am_closest.exe which would then return the closest color that the ArtMap plugin provides for each pixel.

ArMap Closest can be found here:

https://github.com/Lateralus138/ArtMapMapImage

Minecraft ArtMap Plugin

The Minecraft ArtMap plugin is maintained here: https://gitlab.com/BlockStack/ArtMap and as such more information about the plugin can be found there.

I use this plugin when playing on the Minecraft server Creation Nation:

play.cnation.net

or

buzz.cnation.net

Cration Nation Logo

Motivation

Doing art with this plugin is fun, but can be a long and tedious chore and I needed tools to help me streamline the process.


Usage

All files can be found in the Releases tab/section.

Environment

This is a command line tool with arguments and as such can be run from any console/terminal, Run, shortcut, AutoHotkey, or any other method of launching a console application. I only have a Windows version for now, but I do plan to convert for Linux.

How To Use

As with any portable program this can be placed anywhere you like on your machine, but more preferably in a directory that is in your %PATH% environment variable so you can run it without a full path (am_mapimage for example). I recommend using a dedicated Bin directory, but of course, it's your choice. If your path isn't already in your %PATH% environment then I suggest adding it[1], but if not then you have provide the full path (C:\Path\To\am_mapimage.exe for example) when executing the program.

This can be used by itself, but is best used with another tool: ArtMap Map Image (am_mapimage, coming soon).

Examples

Get Help

PS> am_mapimage -h
usage: am_mapimage.exe [-h] -i INPUT -x1 X_BEGIN -x2 X_END -y1 Y_BEGIN -y2 Y_END

Map image pixels for use in Minecraft's ArtMap plugin.

optional arguments:
  -h, --help            show this help message and exit
  -i INPUT, --input INPUT
                        Input image file path. (default: None)
  -x1 X_BEGIN, --x-begin X_BEGIN
                        The x pixel to begin mapping. (default: None)
  -x2 X_END, --x-end X_END
                        The x pixel to end mapping. (default: None)
  -y1 Y_BEGIN, --y-begin Y_BEGIN
                        The y pixel to begin mapping. (default: None)
  -y2 Y_END, --y-end Y_END
                        The y pixel to end mapping. (default: None)

Read a square of 16 pixels from X1 = 1, X2 = 4, Y1 = 1, and Y2 = 4

PS> am_mapimage -i C:\Path\To\Image.png -x1 1 -x2 4 -y1 1 -y2 4
0xf6f194
0xf8f19c
0xf8f1a1
0xf3ee7c
0xf6f193
0xf8f19b
0xf8f1a1
0xf2ee79
0xf6f092
0xf8f19b
0xf8f1a2
0xf2ee79
0xf6f092
0xf8f19a
0xf8f1a1
0xf3ee7e

Feed output to am_closest in Powershell

PS> am_closest @($(am_mapimage -i C:\Path\To\Image.png -x1 1 -x2 4 -y1 1 -y2 4))
Pumpkin Seeds
Pumpkin Seeds
Pumpkin Seeds
Pumpkin Seeds
Pumpkin Seeds
Pumpkin Seeds
Pumpkin Seeds
Pumpkin Seeds
Pumpkin Seeds
Pumpkin Seeds
Pumpkin Seeds
Pumpkin Seeds
Pumpkin Seeds
Pumpkin Seeds
Pumpkin Seeds
Pumpkin Seeds

Project Information

This project is written in Python.

Python

Changelog

  • 1.0.0.0 - Initial release.

Coming Updates

  • Nothing planned.

Source File Quality

This is graded by CodeFactor and is subjective, but helps me to refactor my work.

Name Status
codefactor.io

File MD5 Hashes

All hashes are retrieved at compile/build time.

Current Windows MD5

WINDOWS X86 MD5

Other Miscellaneous File Information

Description Status
Project Release Date GitHub Release Date
Total downloads for this project GitHub all releases
Complete repository size This Repo Size
Commits in last month GitHub commit activity
Commits in last year GitHub commit activity

Notes

Note 1

Adding a path to the Windows %PATH% environment variable search @ DuckDuckGo


Media

Logo

LOGO

Help

HELP


Support Me If You Like

If you like any of the projects below and care to donate to my PayPal:

PayPal Donation

Or Buy Me A Coffee if your prefer:

Buy Me A Coffee


License Info

License Excerpt
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.