Skip to content

Commit 8a3fc83

Browse files
authored
Update README.md
1 parent 3920238 commit 8a3fc83

File tree

1 file changed

+24
-35
lines changed

1 file changed

+24
-35
lines changed

README.md

Lines changed: 24 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -6,25 +6,26 @@ THIS PROJECT IS NO OFFICIAL MINECRAFT PRODUCT - NOT AUTHORIZED OR ASSOCIATED BY
66

77
## Description
88

9-
Look at https://github.com/ozelot379/ConvertJavaTextureToBedrock#user-content-description
9+
It supports the follow Minecraft versions:
1010

11-
## Requirements
12-
13-
This is an "ES module"
11+
| Minecraft | Version |
12+
|-----------|---------|
13+
| Java | v1.13.x, v1.14.x, v1.15.x or v1.16.x |
14+
| Bedrock | >= v1.16.20 |
1415

15-
So it requires a current web browser or NodeJS v14
16-
17-
If you need older support, please try to use something like `webpack` or `babel`
16+
## Requirements
17+
* This is an "ES module".
18+
* So it requires a current web browser or NodeJS v14.
19+
* If you need older support, please try to use something like `webpack` or `babel`
1820

1921
## Use it direct in your code
20-
21-
Add it as a dependency to your `package.json`
22+
* Add it as a dependency to your `package.json`
2223

2324
```bash
24-
yarn add @ozelot379/convert-minecraft-java-texture-to-bedrock-api
25+
yarn add github:ModifiedCommand/ConvertJavaTextureToBedrockApi
2526
```
2627

27-
You can convert your texture packs like
28+
* You can convert your texture packs like
2829

2930
```javascript
3031
import {ConsoleLog, Input, LocalFileInputEntry, LocalFileOutput} from "@ozelot379/convert-base-api";
@@ -45,41 +46,29 @@ import {ConvertJavaTextureToBedrockApi} from "@ozelot379/convert-minecraft-java-
4546
})();
4647
```
4748

48-
More infos at https://github.com/ozelot379/ConvertBaseApi#user-content-description
49-
5049
## Extras (for texture pack creators)
5150

5251
### UUID
53-
54-
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
52+
* 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
5553

5654
### Custom textures
57-
58-
You can put custom textures in a `bedrock_textures` folder in your input
59-
60-
For instance for textures, that can not be converted or are not converted correctly
61-
62-
This files are applied additionally before output
55+
* You can put custom textures in a `bedrock_textures` folder in your input.
56+
* For instance for textures, that can not be converted or are not converted correctly.
57+
* This files are applied additionally before output
6358

6459
## How this work
6560

6661
This project uses the follow main features or external libraries:
6762

68-
- [Web Worker](https://developer.mozilla.org/docs/Web/API/Web_Workers_API) for convert it in the background to not freeze the browser ui (Web app)
69-
- [jszip](https://www.npmjs.com/package/jszip) for read, modify and write zip files
70-
- [jimp](https://www.npmjs.com/package/jimp) for graphic manipulation
71-
- [file-saver](https://www.npmjs.com/package/file-saver) for deliver the converted pack to download (Web app)
72-
- [webpack](https://www.npmjs.com/package/webpack) for bundle the dist code (Web app)
73-
- [Service Worker](https://developer.mozilla.org/en-US/docs/Web/API/Service_Worker_API) for offline cache and usage (Web app)
63+
* [Web Worker](https://developer.mozilla.org/docs/Web/API/Web_Workers_API) for convert it in the background to not freeze the browser ui (Web app)
64+
* [jszip](https://www.npmjs.com/package/jszip) for read, modify and write zip files
65+
* [jimp](https://www.npmjs.com/package/jimp) for graphic manipulation
66+
* [file-saver](https://www.npmjs.com/package/file-saver) for deliver the converted pack to download (Web app)
67+
* [webpack](https://www.npmjs.com/package/webpack) for bundle the dist code (Web app)
68+
* [Service Worker](https://developer.mozilla.org/en-US/docs/Web/API/Service_Worker_API) for offline cache and usage (Web app)
7469

7570
## Web app
76-
77-
Look at https://github.com/ozelot379/ConvertJavaTextureToBedrock
78-
79-
## CLI
80-
81-
Look at https://github.com/ozelot379/ConvertJavaTextureToBedrockCli
71+
* Look at the [Source Code](https://github.com/ModifiedCommand/ConvertJavaTextureToBedrock) or [Webapp](https://modifiedcommand.github.io/ConvertJavaTextureToBedrock/)
8272

8373
## Report issue
84-
85-
Use github repo issues (https://github.com/ozelot379/ConvertJavaTextureToBedrock/issues/new/choose)
74+
* Use [GitHub issues](https://github.com/ModifiedCommand/ConvertJavaTextureToBedrock/issues/new/choose

0 commit comments

Comments
 (0)