@@ -2,7 +2,11 @@ THIS PROJECT IS NO OFFICIAL [MINECRAFT](https://minecraft.net/) PRODUCT - NOT AU
22
33---
44
5- Convert Minecraft Java texture packs to Minecraft Bedrock texture packs
5+ # Convert Minecraft Java texture packs to Minecraft Bedrock texture packs
6+
7+ Look at https://ozelot379.github.io/ConvertMinecraftJavaTextureToBedrock
8+
9+ It works directly in your browser
610
711It supports currently the follow Minecraft versions:
812
@@ -13,19 +17,16 @@ It supports currently the follow Minecraft versions:
1317
1418Currently it supports to convert blocks, items, entities, paintings, particles, map icons and mob effects textures
1519
16- Supported formats are zip archives or folders
20+ Some conversions of HD texture packs may takes a while
1721
1822This project is inspired by the no longer continued [ PCTexture2PE] ( https://github.com/rodrigojxd/PCTexture2PE )
1923
20- # Usage
21-
22- ## GUI
23- Look at https://ozelot379.github.io/ConvertMinecraftJavaTextureToBedrock in your browser
24-
2524## CLI
25+ As an alternative you can also use the cli version
26+
2627First be sure you have installed [ NodeJS] ( https://nodejs.org ) (At least the LTS version) and install [ Yarn] ( https://yarnpkg.com/en/docs/install )
2728
28- Then install it global
29+ Then install this global so you can use the binary
2930
3031``` bash
3132yarn global add @ozelot379/convert-minecraft-java-texture-to-bedrock
@@ -59,7 +60,7 @@ For instance for textures, that can not be converted or are not converted correc
5960
6061This files are applied additionally before output
6162
62- ## Debug and build
63+ # Debug and build
6364First clone this repo and install the dependencies
6465
6566``` bash
@@ -85,17 +86,16 @@ yarn build
8586```
8687
8788# How this work
89+ This project uses the follow main features or external libraries:
8890
89- This project uses the follow main external libraries:
90-
91+ - [ Web Worker] ( https://developer.mozilla.org/de/docs/Web/API/Web_Workers_API ) for convert it in the background to not freeze the gui
9192- [ jszip] ( https://www.npmjs.com/package/jszip ) for read, modify and write zip files
9293- [ jimp] ( https://www.npmjs.com/package/jimp ) for graphic manipulation
93- - [ file-saver] ( https://www.npmjs.com/package/file-saver ) for deliver the generated as download
94+ - [ file-saver] ( https://www.npmjs.com/package/file-saver ) for deliver the converted pack to download
9495- [ webpack] ( https://www.npmjs.com/package/webpack ) for bundle the dist code
9596- [ gh-pages] ( https://www.npmjs.com/package/gh-pages ) for publish a new version to the github static page
9697
97-
98- ## Use it direct in your code
98+ # Use it direct in your code
9999Add it as a dependency to your ` package.json `
100100
101101``` bash
@@ -125,14 +125,14 @@ or self handle the `Promise`
125125new ConvertMinecraftJavaTextureToBedrock (input, output, log).convert ().then ((output ) => {}).catch ((err ) => {});
126126```
127127
128- ### Input
128+ ## Input
129129| Import | Description |
130130| -----------------| -------------|
131131| ` Input ` | The input consists on one input entry (Common) |
132132| ` ArrayInput ` | The input consists on multiple input entries (For instance a selected folder with multiple ` FileInputEntry ` ) |
133133| ` AbstractInput ` | Base input |
134134
135- ### Input entry
135+ ## Input entry
136136| Import | For type |
137137| -------------------------| --------------------|
138138| ` BufferInputEntry ` | <ul ><li >` ArrayBuffer ` </li ><li >` Blob ` </li ><li >` Buffer ` </li ><li >` Uint8Array ` </li ></ul > |
@@ -141,7 +141,7 @@ new ConvertMinecraftJavaTextureToBedrock(input, output, log).convert().then((out
141141| ` LocalFolderInputEntry ` | Local folder |
142142| ` AbstractInputEntry ` | Base input entry |
143143
144- ### Output
144+ ## Output
145145| Import | For type |
146146| ---------------------| ---------------|
147147| ` ArrayBufferOutput ` | ` ArrayBuffer ` |
@@ -153,14 +153,14 @@ new ConvertMinecraftJavaTextureToBedrock(input, output, log).convert().then((out
153153| ` Uint8ArrayOutput ` | ` Uint8Array ` |
154154| ` AbstractOutput ` | Base output |
155155
156- ### Log
156+ ## Log
157157| Import | Description |
158158| ---------------| ----------------|
159159| ` ConsoleLog ` | Log to console |
160160| ` SlientLog ` | Disable log |
161161| ` AbstractLog ` | Base log |
162162
163- ### Example
163+ ## Example
164164``` javascript
165165import ConvertMinecraftJavaTextureToBedrock , {ConsoleLog , Input , LocalFileInputEntry , LocalFileOutput } from " @ozelot379/convert-minecraft-java-texture-to-bedrock" ;
166166
0 commit comments