v4.0.0

Author: ozelot379

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## [4.0.0]
+- Remove convert piglin
+- Fix banner pattern black
+- Fix banner pattern preview max size
+- Fix banner illager pattern
+- Warn for partially missing sprite images (For instance banner pattern, painting and particle), because may they will be transparent in the result
+- Separate base api
+
 ## [3.6.1]
 - Fix root folder in sub folder in some wrong texture packs
 - Fix rename files in local folder to not exists folder

README.md

@@ -24,80 +24,19 @@ Add it as a dependency to your `package.json`
 yarn add @ozelot379/convert-minecraft-java-texture-to-bedrock-api
 ```
 
-Import it in your code
+You can convert your texture packs like
 
 ```javascript
-import {ConsoleLog, ConvertJavaTextureToBedrockApi, Input, LocalFileInputEntry, LocalFileOutput} from "@ozelot379/convert-minecraft-java-texture-to-bedrock-api";
-```
-
-You can now convert your texture packs
-
-```javascript
-let output;
-try {
-    output = await new ConvertJavaTextureToBedrockApi(input, output, log, options).convert();
-} catch (err) {
-
-}
-```
-
-### Input
-
-| Import | Description |
-|--------|-------------|
-| `Input` | The input consists on one input entry (Common) |
-| `ArrayInput` | The input consists on multiple input entries (For instance a selected folder with multiple `FileInputEntry`) |
-| `AbstractInput` | Base input |
-
-### Input entry
-
-| Import | For type |
-|--------|----------|
-| `BufferInputEntry` | - `ArrayBuffer`<br>- `Blob`<br>- `Buffer`<br>- `Uint8Array` |
-| `FileInputEntry` | `File` |
-| `LocalFileInputEntry` | Local file |
-| `LocalFolderInputEntry` | Local folder |
-| `AbstractInputEntry` | Base input entry |
-
-### Output
-
-| Import | For type |
-|--------|----------|
-| `ArrayBufferOutput` | `ArrayBuffer` |
-| `BlobOutput` | `Blob` |
-| `BufferOutput` | `Buffer` |
-| `FileBlobOutput` | `File` |
-| `LocalFileOutput` | Local file |
-| `LocalFolderOutput` | Local folder |
-| `Uint8ArrayOutput` | `Uint8Array` |
-| `AbstractOutput` | Base output |
-
-### Log
-
-| Import | Description |
-|--------|-------------|
-| `ConsoleLog` | Log to console |
-| `SlientLog` | Disable log |
-| `AbstractLog` | Base log |
-
-### Options
-
-| Key | Type | Default | Description |
-|-----|------|---------|-------------|
-| `experimental` | `bool` | `false` | Enable experimental conversions |
-
-### Example
-
-```javascript
-import {ConsoleLog, ConvertJavaTextureToBedrockApi, Input, LocalFileInputEntry, LocalFileOutput} from "@ozelot379/convert-minecraft-java-texture-to-bedrock-api";
+import {ConsoleLog, Input, LocalFileInputEntry, LocalFileOutput} from "@ozelot379/convert-base-api";
+import {ConvertJavaTextureToBedrockApi} from "@ozelot379/convert-minecraft-java-texture-to-bedrock-api";
 
 (async () => {
     let output;
 
     try {
         output = await new ConvertJavaTextureToBedrockApi(new Input(new LocalFileInputEntry("input/java_texture_pack.zip")), new LocalFileOutput("output/bedrock_texture_pack.mcpack"), new ConsoleLog()).convert();
     } catch (err) {
-        console.log(err);
+        console.err(err);
 
         return;
     }
@@ -106,6 +45,8 @@ import {ConsoleLog, ConvertJavaTextureToBedrockApi, Input, LocalFileInputEntry,
 })();
 ```
 
+More infos at https://github.com/ozelot379/ConvertBaseApi#user-content-description 
+
 ## Extras (for texture pack creators)
 
 ### UUID

package.json

@@ -2,7 +2,7 @@
   "name": "@ozelot379/convert-minecraft-java-texture-to-bedrock-api",
   "type": "module",
   "productName": "ConvertJavaTextureToBedrockApi",
-  "version": "3.6.1",
+  "version": "4.0.0",
   "description": "API for convert Minecraft Java texture packs to Bedrock texture packs",
   "keywords": [
     "Minecraft",
@@ -23,11 +23,8 @@
   },
   "homepage": "https://github.com/ozelot379/ConvertJavaTextureToBedrockApi#readme",
   "dependencies": {
-    "@ozelot379/jimp-plugins": "1.2.6",
-    "jimp": "0.9.8",
-    "jszip": "3.4.0",
-    "tga": "1.0.3",
-    "uuid": "3.4.0"
+    "@ozelot379/convert-base-api": "1.0.0",
+    "uuid": "8.3.0"
   },
   "devDependencies": {},
   "engines": {

src/ConvertJavaTextureToBedrockApi.mjs

@@ -1,115 +1,30 @@
-import {AbstractInput} from "./input/AbstractInput.mjs";
-import {AbstractLog} from "./log/AbstractLog.mjs";
-import {AbstractOutput} from "./output/AbstractOutput.mjs";
-import {addAdditionalConverters, getConverters} from "./converter/converters.mjs";
-import {Options} from "./Options.mjs";
+import {AbstractBaseApi} from "@ozelot379/convert-base-api";
+import {converters} from "./converter/index.mjs";
 
 /**
  * Class ConvertJavaTextureToBedrockApi
  */
-class ConvertJavaTextureToBedrockApi {
+class ConvertJavaTextureToBedrockApi extends AbstractBaseApi {
     /**
-     * ConvertJavaTextureToBedrockApi constructor
-     *
-     * @param {AbstractInput} input
-     * @param {AbstractOutput} output
-     * @param {AbstractLog} log
-     * @param {Options} options
-     */
-    constructor(input, output, log, options = {}) {
-        /**
-         * @type {AbstractInput}
-         *
-         * @protected
-         */
-        this.input = input;
-        /**
-         * @type {AbstractOutput}
-         *
-         * @protected
-         */
-        this.output = output;
-        /**
-         * @type {AbstractLog}
-         *
-         * @protected
-         */
-        this.log = log;
-        /**
-         * @type {AsyncIterableIterator<AbstractConverter>}
-         *
-         * @protected
-         */
-        this.converters = getConverters();
-        /**
-         * @type {Options}
-         *
-         * @protected
-         */
-        this.options = {
-            ...new Options(),
-            ...options
-        };
-    }
-
-    /**
-     * @returns {Promise<*>}
+     * @inheritDoc
      */
     async convert() {
-        this.log.log("Start conversion");
-
         if (this.options.experimental) {
             this.log.warn(`EXPERIMENTAL CONVERSIONS ENABLED!`)
         }
 
-        await this.handleInput();
-
-        await this.handleConverters();
-
-        const output = await this.handleOutput();
-
-        this.log.log("Conversion finished");
+        const output = await super.convert();
 
         this.log.log("Please reopen Minecraft after selecting the converted texture pack, because in the current version it seems to be a bug to reload the texture cache (Otherwise it's possible that you will have a mix between your previous and new texture pack, which can lead to appearance bugs that would not occur)");
 
         return output;
     }
 
     /**
-     * @returns {Promise<void>}
-     *
-     * @protected
-     */
-    async handleInput() {
-        await this.output._init(this.input, this.log, this.options);
-
-        for await (const entry of this.input.getEntries()) {
-            await entry._init(this.log, this.options);
-
-            await this.output.applyInputEntry(entry);
-        }
-    }
-
-    /**
-     * @returns {Promise<void>}
-     *
-     * @protected
-     */
-    async handleConverters() {
-        for await (const converter of this.converters) {
-            await converter._init(this.input, this.output, this.log, this.options);
-
-            await addAdditionalConverters(...await converter.convert());
-        }
-    }
-
-    /**
-     * @returns {Promise<*>}
-     *
-     * @protected
+     * @inheritDoc
      */
-    async handleOutput() {
-        return this.output.generate();
+    async getInitConverters() {
+        return converters;
     }
 }