Skip to content

Commit 0528324

Browse files
author
ozelot379
committed
WIP
1 parent dcc9fdb commit 0528324

1 file changed

Lines changed: 21 additions & 0 deletions

File tree

‎README.md‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,19 @@ THIS PROJECT IS NO OFFICIAL MINECRAFT PRODUCT - NOT AUTHORIZED OR ASSOCIATED BY
55
# Convert Minecraft Java texture packs to Bedrock texture packs
66

77
## Description
8+
89
Look at https://github.com/ozelot379/ConvertJavaTextureToBedrock#user-content-description
910

11+
## Requirements
12+
13+
This is an "ES module"
14+
15+
So it requires a current web browser or NodeJS v14
16+
17+
If you need older support, please use something like `webpack` or `babel`
18+
1019
## Use it direct in your code
20+
1121
Add it as a dependency to your `package.json`
1222

1323
```bash
@@ -32,13 +42,15 @@ try {
3242
```
3343

3444
### Input
45+
3546
| Import | Description |
3647
|--------|-------------|
3748
| `Input` | The input consists on one input entry (Common) |
3849
| `ArrayInput` | The input consists on multiple input entries (For instance a selected folder with multiple `FileInputEntry`) |
3950
| `AbstractInput` | Base input |
4051

4152
### Input entry
53+
4254
| Import | For type |
4355
|--------|----------|
4456
| `BufferInputEntry` | - `ArrayBuffer`<br>- `Blob`<br>- `Buffer`<br>- `Uint8Array` |
@@ -48,6 +60,7 @@ try {
4860
| `AbstractInputEntry` | Base input entry |
4961

5062
### Output
63+
5164
| Import | For type |
5265
|--------|----------|
5366
| `ArrayBufferOutput` | `ArrayBuffer` |
@@ -60,13 +73,15 @@ try {
6073
| `AbstractOutput` | Base output |
6174

6275
### Log
76+
6377
| Import | Description |
6478
|--------|-------------|
6579
| `ConsoleLog` | Log to console |
6680
| `SlientLog` | Disable log |
6781
| `AbstractLog` | Base log |
6882

6983
### Options
84+
7085
| Key | Type | Default | Description |
7186
|-----|------|---------|-------------|
7287
| `experimental` | `bool` | `false` | Enable experimental conversions |
@@ -94,16 +109,19 @@ import {ConsoleLog, ConvertJavaTextureToBedrock, Input, LocalFileInputEntry, Loc
94109
## Extras (for texture pack creators)
95110

96111
### UUID
112+
97113
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
98114

99115
### Custom textures
116+
100117
You can put custom textures in a `bedrock_textures` folder in your input
101118

102119
For instance for textures, that can not be converted or are not converted correctly
103120

104121
This files are applied additionally before output
105122

106123
## How this work
124+
107125
This project uses the follow main features or external libraries:
108126

109127
- [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)
@@ -115,10 +133,13 @@ This project uses the follow main features or external libraries:
115133
- [Service Worker](https://developer.mozilla.org/en-US/docs/Web/API/Service_Worker_API) for offline cache and usage (web app)
116134

117135
## Web app
136+
118137
Look at https://github.com/ozelot379/ConvertJavaTextureToBedrock
119138

120139
## CLI
140+
121141
Look at https://github.com/ozelot379/ConvertJavaTextureToBedrockCli
122142

123143
## Report issue
144+
124145
Use github repo issues (https://github.com/ozelot379/ConvertJavaTextureToBedrock/issues/new/choose)

0 commit comments

Comments
 (0)