README.md

MC-3DS-Flip

• An CLI that "Just Works" with Minecraft .3DST Skins, Textures, and More.
• Inspired by @DaniElectra's Anime Channel 3DSTTOOL.

MC-3DS-Flip (GUI)

• An W.I.P. GUI that "Just Works" with Minecraft .3DST Skins, Textures, and More.
• This is a Work-In-Progress Adaptation, and the current release only supports color extraction.
• I'm always looking for bugs, and squashing them. But sometimes these go unseen even by my standards. If you found a bug in the GUI, create an issue request via the Tab above!

Features:

• Flips normal *.png Images From Java to MC-3DS.
• Can Flip Compiled *.3dst Files. Both X & Y Only Axis ATM.
• Change Color of Compiled *.3DST Files. See CLI/CLU Usage for additional information.
• Grab Data from Both File Types using the "-g" flag in the CLI
• Partial Conversion Support (Can Convert Between Both PNG and 3DST Somewhat).
• Brand new GUI (Graphical) being built from the ground up using some of the code from the CLI (Command-Line).

Usage:

CLI/CLU Usage:

#  Utility Commands:
> .\m3dsflip help

#  3DST Commands:
> .\m3dsflip 3dstflip <image_path>
> .\m3dsflip -c -invert <image_path>
> .\m3dsflip -c -green <image_path>
> .\m3dsflip -c -orange <image_path>
> .\m3dsflip -c -red <image_path>
> .\m3dsflip -c -blue <image_path>
> .\m3dsflip -c -extract <image_path>
> .\m3dsflip -g -meta <image_path>
> .\m3dsflip -g -head <image_path>
> .\m3dsflip -con <3dst_image_path>


#  PNG Commands:
> .\m3dsflip yflip <image_path>
> .\m3dsflip xflip <image_path>
> .\m3dsflip -g -head <image_path>
> .\m3dsflip -g -body <image_path>
> .\m3dsflip -g -larm <image_path>
> .\m3dsflip -g -rarm <image_path>
> .\m3dsflip -g -lleg <image_path>
> .\m3dsflip -g -rleg <image_path>
> .\m3dsflip -con <png_image_path>

Command Explanation:

> .\m3dsflip <flag> <command/args> <image_path>

> .\m3dsflip     =  Call Executable
> <flag>         =  -c (Color Flag), -g (Grab Flag), -con (Convert Flag).
> <command/ags>  =  Commands Such as "yflip" or "3dstflip" (or Args Such as "-invert" or "-orange").
> <image_path>   =  Image Path (If path has "speaces" within it, surround it in quotes. An Example: "C:\Windows\Users\batch user384\skin.png").

Building:

> pyinstaller -F --strip --exclude-module numpy --exclude-module opencv --exclude-module cv2 --onefile "m3dsflip.py" --icon="favicon.ico"

Source Usage:

python m3dsflip.py <flag> <command/arg> <image_path>

Notice:

• If you decide to change the color/hue of your *.3DST Skin.
• I am not responsible for any data that might become corrupted, or if the output is not the desired result.
• Blurry Images on this GitHub page do NOT reflect the quality (enlarged so you can see them).
• These Skin Hue Changes do NOT work on all skins. Make sure your *.3DST Skin is a compatible size: 16.0kb.
• **Converting Between Formats is VERY experimental. As such converting is not reccomended. But has been added.
• The "-g" Flag can either Grab .3DST MetaData, or Grab .PNG Body Parts currently.

Download:

• Compiled "CLI" Download Avaliable Here.
• Compiled "GUI" Download Avaliable Here.

Road-Map (Updates/Patches):

1. finish the "-g" flag (Whicy will support grabbing multiple body parts of both Images). *(High Priority | 55% Way There).

2. A "-r" flag will be added flag to replace body parts with of Compiled .3DST Skins. *(Mid Priority)

3. Proper Flipping of Compiled .3DST Skins. *(High Priority)

4. Converting Between .PNG and Compiled .3DST Skins. *(Mid Priority | 50% Way There).

Documentation on 3DST:

You're In Luck!

• I have made a simple Documentation Repository so you can make your Own Utilities!
• The "documentation" is a bit technical, so make sure you know how to read/write in Hex Moderately Fluently.

Image Gallery: