https://github.com/masaishi/mc_map2png
This Rust application transforms Minecraft map data from NBT format into a visual PNG image. Additionally, a WebAssembly module is available for converting images on the client side.
https://github.com/masaishi/mc_map2png
Last synced: 5 months ago
JSON representation
This Rust application transforms Minecraft map data from NBT format into a visual PNG image. Additionally, a WebAssembly module is available for converting images on the client side.
- Host: GitHub
- URL: https://github.com/masaishi/mc_map2png
- Owner: masaishi
- License: mit
- Created: 2024-04-14T12:41:39.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-14T14:57:43.000Z (about 1 year ago)
- Last Synced: 2024-12-17T06:41:46.350Z (6 months ago)
- Language: Rust
- Homepage: https://masaishi.github.io/mc_map2png/
- Size: 319 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Minecraft Map to PNG Converter
This Rust application transforms Minecraft map data from NBT format into a visual PNG image. Additionally, a WebAssembly module is available for converting images on the client side.
## Features
- Convert compressed Minecraft map NBT files to PNG images.
- Direct memory-based image processing suitable for web assembly integration.
- Efficient error handling and informative error messages.
## Demo Site
[Demo Site](https://masaishi.github.io/mc_map2png)
I provide a web interface that allows users to convert Minecraft NBT files to PNG images directly within their browser.
The website is built using HTML and Tailwind CSS for styling. It features a simple drag-and-drop interface for file upload, a convert button, and displays the resulting PNG image which can then be downloaded. The site runs entirely client-side, leveraging WebAssembly to perform image conversion.
## WebAssembly Usage
To use the WebAssembly module with [`mc_map2png`](https://www.npmjs.com/package/mc_map2png), follow these steps in your web application:
1. Install the `mc_map2png` package:
```
npm i mc_map2png
```
2. Initialize the WASM Module: Ensure that the WASM module is loaded and initialized correctly. Import the functions from the `mc_map2png` package.
```javascript
import * as mc_map2png from 'mc_map2png';
```
3. File Processing: Convert user-uploaded files by reading them into an ArrayBuffer, then pass this buffer to the WASM function:
```javascript
const fileInput = document.getElementById('fileInput');
const file = fileInput.files[0];
const arrayBuffer = await file.arrayBuffer();
const result = await mc_map2png.process_image_from_memory(new Uint8Array(arrayBuffer));
```
4. Displaying the Image: Upon successful conversion, display the image or handle errors appropriately:
```javascript
if (result instanceof Uint8Array) {
const blob = new Blob([result], { type: 'image/png' });
const url = URL.createObjectURL(blob);
document.getElementById('outputImage').src = url;
} else {
console.error('Conversion failed.');
}
```
5. Download Option: Provide users with the option to download the generated PNG:
```javascript
const downloadButton = document.getElementById('downloadButton');
downloadButton.onclick = () => {
const link = document.createElement('a');
link.href = URL.createObjectURL(new Blob([result], { type: 'image/png' }));
link.download = 'converted-image.png';
link.click();
};
```
## Installation
Clone the repository to your local machine:
```bash
git clone https://github.com/masaishi/mc_map2png.git
cd mc_map2png
```
Build the project using Cargo:
```bash
cargo build --release
```
## Usage
To convert an NBT file to a PNG image, run:
```bash
cargo run --release --
```
Where:
- `` is the path of Minecraft map NBT file. (e.g., `map_0.dat`)
- `` is the desired path for the output PNG file. (e.g., `map_0.png`)