Skip to content

Commit 5e0c359

Browse files
author
ozelot379
committed
Merge branch 'develop' into 'master'
Restruct readme See merge request minecraft/convert-minecraft-java-texture-to-bedrock!6
2 parents f6fdab8 + 9577094 commit 5e0c359

1 file changed

Lines changed: 58 additions & 52 deletions

File tree

‎README.md‎

Lines changed: 58 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
THIS PROJECT IS NO OFFICIAL [MINECRAFT](https://minecraft.net/) PRODUCT - NOT AUTHORIZED OR ASSOCIATED BY [MOJANG](https://mojang.com/)
2+
3+
---
4+
15
Convert Minecraft Java texture packs to Minecraft Bedrock texture packs
26

37
It supports currently the follow Minecraft versions:
@@ -11,11 +15,7 @@ Currently it supports to convert blocks, items, entities, paintings, particles,
1115

1216
Supported formats are zip archives or folders
1317

14-
This library is inspired by the no longer continued [PCTexture2PE](https://github.com/rodrigojxd/PCTexture2PE)
15-
16-
This library is written in NodeJS, with [webpack features](https://www.npmjs.com/package/webpack)
17-
18-
For the graphic manipulation, it uses the [jimp library](https://www.npmjs.com/package/jimp)
18+
This project is inspired by the no longer continued [PCTexture2PE](https://github.com/rodrigojxd/PCTexture2PE)
1919

2020
# Usage
2121

@@ -43,7 +43,59 @@ ConvertMinecraftJavaTextureToBedrock -i input/java_texture_pack.zip -o output/be
4343
| -o (Required) | Output folder or zip path |
4444
| -l | Show log (Default `true`) |
4545

46-
## Direct in your code
46+
## Known issues
47+
- Convert horse textures is very tricky and may buggy
48+
- Convert weather textures (rain and snow) may not works (seems to be an other format as the default)
49+
50+
# Extras (for texture pack creators)
51+
52+
## UUID
53+
You can create the `bedrock_uuid_header` and `bedrock_uuid_module` files in your input, to keep the same uuid on repeating conversions - otherwise, random uuids are generated each time and you need to reselect the texture pack again in the game
54+
55+
## Custom textures
56+
You can put custom textures in a `bedrock_textures` folder in your input
57+
58+
For instance for textures, that can not be converted or are not converted correctly
59+
60+
This files are applied additionally before output
61+
62+
## Debug and build
63+
First clone this repo and install the dependencies
64+
65+
```bash
66+
yarn
67+
```
68+
69+
Then you can start the debug
70+
71+
cli:
72+
```bash
73+
yarn debug:cli
74+
```
75+
76+
webapp:
77+
```bash
78+
yarn debug:webapp
79+
```
80+
81+
You can create a build
82+
83+
```bash
84+
yarn build
85+
```
86+
87+
# How this work
88+
89+
This project uses the follow main external libraries:
90+
91+
- [jszip](https://www.npmjs.com/package/jszip) for read, modify and write zip files
92+
- [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+
- [webpack](https://www.npmjs.com/package/webpack) for bundle the dist code
95+
- [gh-pages](https://www.npmjs.com/package/gh-pages) for publish a new version to the github static page
96+
97+
98+
## Use it direct in your code
4799
Add it as a dependency to your `package.json`
48100

49101
```bash
@@ -126,49 +178,3 @@ import ConvertMinecraftJavaTextureToBedrock, {ConsoleLog, Input, LocalFileInputE
126178
console.log(`Output: ${output}`);
127179
})();
128180
```
129-
130-
## Known issues
131-
- Convert horse textures is very tricky and may buggy
132-
- Convert weather textures (rain and snow) may not works (seems to be an other format as the default)
133-
134-
# Extras (for texture pack creators)
135-
136-
## UUID
137-
You can create the `bedrock_uuid_header` and `bedrock_uuid_module` files in your input, to keep the same uuid on repeating conversions - otherwise, random uuids are generated each time and you need to reselect the texture pack again in the game
138-
139-
## Custom textures
140-
You can put custom textures in a `bedrock_textures` folder in your input
141-
142-
For instance for textures, that can not be converted or are not converted correctly
143-
144-
This files are applied additionally before output
145-
146-
## Debug and build
147-
First clone this repo and install the dependencies
148-
149-
```bash
150-
yarn
151-
```
152-
153-
Then you can start the debug
154-
155-
cli:
156-
```bash
157-
yarn debug:cli
158-
```
159-
160-
webapp:
161-
```bash
162-
yarn debug:webapp
163-
```
164-
165-
You can create a build
166-
167-
```bash
168-
yarn build
169-
```
170-
171-
# License
172-
The Minecraft Java and Bedrock products are © by [Mojang](https://mojang.com/)
173-
174-
This library for the conversation is published by the [GPL license](https://www.gnu.org/licenses/gpl-3.0.txt)

0 commit comments

Comments
 (0)