Skip to content

Commit

Permalink
Add images to README.
Browse files Browse the repository at this point in the history
  • Loading branch information
Frumple committed Feb 5, 2023
1 parent 4f3ca33 commit 63633d6
Showing 1 changed file with 15 additions and 7 deletions.
22 changes: 15 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,22 @@
# Image to Minecraft Map

### Live App: [https://frumple.github.io/image-to-minecraft-map][app]
A web application that converts images to Minecraft NBT map .dat files, allowing such images to be displayed in Minecraft.

**Chrome and Edge are recommended.** Firefox has a known issue (see below). Safari is not currently supported.
![photos-app](https://user-images.githubusercontent.com/68396/216803044-6cf1b116-d99d-4b95-818a-d7f8da15497a.png)
![photos-minecraft](https://user-images.githubusercontent.com/68396/216803198-c1311fcb-5a41-4781-8e41-a3b2a7d8a35a.png)

### Quick Start Instructions: [https://github.com/Frumple/image-to-minecraft-map/wiki][wiki]
## How to Use

A web application that converts images to Minecraft NBT map .dat files, allowing such images to be displayed in Minecraft.
### Live Application: [https://frumple.github.io/image-to-minecraft-map][app]

**Chrome and Edge are recommended.** Firefox has a known issue (see below). Safari is not currently supported.

If you think you've discovered a bug, please report it as an [issue][issues]. Be sure to provide as much detail as possible including exact steps to reproduce, settings, image file, and browser used.
### Quick Start Instructions: [https://github.com/Frumple/image-to-minecraft-map/wiki][wiki]

## Features

- Drag-and-drop multiple image files at once and process them simultaneously.
- Split an image into multiple horizontal and vertical maps, in grid patterns such as 2x2, 3x3, etc.
- Split an image into multiple maps horizontally and vertically, into grid patterns such as 2x2, 3x3, etc.
- Download maps as .dat files, or a .zip file containing the .dat files.
- Supports various color difference algorithms: CompuPhase, Euclidean, DeltaE 1976 and 2000, and CMC 1984.
- Supports Floyd-Steinberg dithering.
Expand Down Expand Up @@ -48,16 +51,21 @@ Start the development server:

This application implements the ["CompuPhase" color difference algorithm][compuphase], provided under the [Creative Commons BY-SA 3.0 License][cc-by-sa-3].

Sample images used in this README:
- "Rainbow-Lorikeet-1" by "John" at https://www.flickr.com/photos/34534185@N00/9004576204, available under the [Creative Commons BY-SA 2.0 License][cc-by-sa-2].
- "Rubber Duck in Seoul" by "travel oriented" at https://www.flickr.com/photos/99958070@N02/15348035017, available under the [Creative Commons BY-SA 2.0 License][cc-by-sa-2].

## License

Image to Minecraft Map is licensed under the [MIT License][mit].

Image to Minecraft Map is not affiliated in any way with Mojang or Microsoft.

[app]: https://frumple.github.io/image-to-minecraft-map
[cc-by-sa-2]: https://creativecommons.org/licenses/by-sa/2.0/
[cc-by-sa-3]: https://creativecommons.org/licenses/by-sa/3.0/
[color.js]: https://colorjs.io/
[compuphase]: https://www.compuphase.com/cmetric.htm
[cc-by-sa-3]: https://creativecommons.org/licenses/by-sa/3.0/
[issues]: https://github.com/Frumple/image-to-minecraft-map/issues
[jszip]: https://github.com/Stuk/jszip
[mit]: https://choosealicense.com/licenses/mit/
Expand Down

0 comments on commit 63633d6

Please sign in to comment.