cyclops-infobook-html 4.0.0 → 5.0.0

package/README.md

@@ -64,7 +64,7 @@ If you want to re-download the mods without re-installing Forge, you can run `ge
 
 ### 2. Icon Generation
 
-This phase should be done using the [Item Exporter mod](https://github.com/CyclopsMC/IconExporter).
+This phase should be done using the [Icon Exporter mod](https://github.com/CyclopsMC/IconExporter).
 
 Simply create a modpack with all the mods that were downloaded in the previous step (including the Item Exporter mod),
 start a world, and run the `/iconexporter export 64` command.

package/bin/generate-infobook-html.js

@@ -54,7 +54,7 @@ function create() {
         yield resourceLoader.loadItemTranslationKeys('registries');
         yield resourceLoader.loadFluidTranslationKeys('registries');
         yield resourceLoader.loadKeybindings(config.keybindings);
-        yield resourceLoader.loadAll(process.cwd(), 'mod_assets');
+        yield resourceLoader.loadAll(process.cwd(), 'mod_assets', config.excludedModLanguages || []);
         // Setup infobook loader
         const infoBookInitializer = new InfoBookInitializer_1.InfoBookInitializer(config);
         infoBookInitializer.registerAppendixHandler('advancement_rewards', new InfoBookAppendixHandlerAdvancementRewards_1.InfoBookAppendixHandlerAdvancementRewards(resourceLoader.getResourceHandler()));

package/lib/infobook/FileWriter.d.ts

@@ -9,5 +9,5 @@ export declare class FileWriter implements IFileWriter {
     private readonly context;
     private readonly writtenFiles;
     constructor(context: ISerializeContext);
-    write(baseName: string, contents: Readable): string;
+    write(baseName: string, contents: () => Readable): Promise<string>;
 }

package/lib/infobook/FileWriter.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.FileWriter = void 0;
+const tslib_1 = require("tslib");
 const fs_1 = require("fs");
 const path_1 = require("path");
 /**
@@ -12,12 +13,18 @@ class FileWriter {
         this.writtenFiles = {};
     }
     write(baseName, contents) {
-        // Don't write the file if it has been written before
-        if (!this.writtenFiles[baseName]) {
-            contents.pipe(fs_1.createWriteStream(path_1.join(this.context.basePath, 'assets', baseName)));
-            this.writtenFiles[baseName] = true;
-        }
-        return this.context.baseUrl + 'assets/' + baseName;
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            // Don't write the file if it has been written before
+            if (!this.writtenFiles[baseName]) {
+                const eventEmitter = contents().pipe(fs_1.createWriteStream(path_1.join(this.context.basePath, 'assets', baseName)));
+                this.writtenFiles[baseName] = true;
+                yield new Promise((resolve, reject) => {
+                    eventEmitter.on('finish', resolve);
+                    eventEmitter.on('error', reject);
+                });
+            }
+            return this.context.baseUrl + 'assets/' + baseName;
+        });
     }
 }
 exports.FileWriter = FileWriter;

package/lib/infobook/IFileWriter.d.ts

@@ -10,5 +10,5 @@ export interface IFileWriter {
      * @param {"stream".internal.Readable} contents A stream of contents to write.
      * @returns {string} The file path in the output, relative to the output root.
      */
-    write(baseName: string, contents: Readable): string;
+    write(baseName: string, contents: () => Readable): Promise<string>;
 }

package/lib/infobook/IInfoAppendix.d.ts

@@ -19,5 +19,5 @@ export interface IInfoAppendix {
      * @param serializer The HTML serializer.
      * @returns {string} The HTML representation of this appendix.
      */
-    toHtml(context: ISerializeContext, fileWriter: IFileWriter, serializer: HtmlInfoBookSerializer): string;
+    toHtml(context: ISerializeContext, fileWriter: IFileWriter, serializer: HtmlInfoBookSerializer): Promise<string>;
 }

package/lib/infobook/appendix/InfoBookAppendixAd.d.ts

@@ -8,5 +8,5 @@ export declare class InfoBookAppendixAd implements IInfoAppendix {
     readonly skipWrapper: boolean;
     private readonly templateTagIndex;
     constructor();
-    toHtml(context: ISerializeContext, fileWriter: IFileWriter, serializer: HtmlInfoBookSerializer): string;
+    toHtml(context: ISerializeContext, fileWriter: IFileWriter, serializer: HtmlInfoBookSerializer): Promise<string>;
 }

package/lib/infobook/appendix/InfoBookAppendixAd.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.InfoBookAppendixAd = void 0;
+const tslib_1 = require("tslib");
 const pug_1 = require("pug");
 /**
  * An appendix with an add
@@ -11,7 +12,9 @@ class InfoBookAppendixAd {
         this.templateTagIndex = pug_1.compileFile(__dirname + '/../../../template/appendix/ad.pug');
     }
     toHtml(context, fileWriter, serializer) {
-        return this.templateTagIndex(context.googleAdsense);
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            return this.templateTagIndex(context.googleAdsense);
+        });
     }
 }
 exports.InfoBookAppendixAd = InfoBookAppendixAd;

package/lib/infobook/appendix/InfoBookAppendixHandlerAbstractRecipe.d.ts

@@ -14,7 +14,7 @@ export declare abstract class InfoBookAppendixHandlerAbstractRecipe<R extends IR
     static indexRegistry<R extends IRecipe>(registryRead: IRecipeRegistryRead<R>): IRecipeRegistryIndexed<R>;
     createAppendix(data: any): IInfoAppendix;
     protected abstract getRecipeNameUnlocalized(): string;
-    protected abstract serializeRecipe(recipe: R, context: ISerializeContext, fileWriter: IFileWriter, serializer: HtmlInfoBookSerializer): string;
+    protected abstract serializeRecipe(recipe: R, context: ISerializeContext, fileWriter: IFileWriter, serializer: HtmlInfoBookSerializer): Promise<string>;
 }
 export interface IRecipeRegistryRead<R extends IRecipe> {
     recipes: [R];

package/lib/infobook/appendix/InfoBookAppendixHandlerAbstractRecipe.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.InfoBookAppendixHandlerAbstractRecipe = void 0;
+const tslib_1 = require("tslib");
 const fs = require("fs");
 const path_1 = require("path");
 /**
@@ -41,9 +42,9 @@ class InfoBookAppendixHandlerAbstractRecipe {
         }
         return {
             getName: (context) => this.resourceHandler.getTranslation(this.getRecipeNameUnlocalized(), context.language),
-            toHtml: (context, fileWriter, serializer) => {
-                return recipes.map((recipe) => this.serializeRecipe(recipe, context, fileWriter, serializer)).join('<hr />');
-            },
+            toHtml: (context, fileWriter, serializer) => tslib_1.__awaiter(this, void 0, void 0, function* () {
+                return (yield Promise.all(recipes.map((recipe) => this.serializeRecipe(recipe, context, fileWriter, serializer)))).join('<hr />');
+            }),
         };
     }
 }

package/lib/infobook/appendix/InfoBookAppendixHandlerAdvancementRewards.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.InfoBookAppendixHandlerAdvancementRewards = void 0;
+const tslib_1 = require("tslib");
 const pug_1 = require("pug");
 /**
  * Handles advancement rewards appendices.
@@ -26,17 +27,17 @@ class InfoBookAppendixHandlerAdvancementRewards {
         }
         return {
             getName: (context) => this.resourceHandler.getTranslation('gui.advancements', context.language),
-            toHtml: (context, fileWriter, serializer) => {
+            toHtml: (context, fileWriter, serializer) => tslib_1.__awaiter(this, void 0, void 0, function* () {
                 const advancements = advancementsData
                     .map((advancement) => ({
                     description: this.resourceHandler.getTranslation(advancement.description, context.language),
                     title: this.resourceHandler.getTranslation(advancement.title, context.language),
                 }));
-                const rewards = rewardsData
-                    .map((reward) => serializer.createItemDisplay(this.resourceHandler, context, fileWriter, reward, true));
+                const rewards = yield Promise.all(rewardsData
+                    .map((reward) => serializer.createItemDisplay(this.resourceHandler, context, fileWriter, reward, true)));
                 const rewardsString = this.resourceHandler.getTranslation(`gui.cyclopscore.rewards`, context.language);
                 return this.templateAdvancementRewards({ advancements, rewards, rewardsString });
-            },
+            }),
         };
     }
 }

package/lib/infobook/appendix/InfoBookAppendixHandlerCraftingRecipe.d.ts

@@ -10,7 +10,7 @@ export declare class InfoBookAppendixHandlerCraftingRecipe extends InfoBookAppen
     private readonly templateCraftingRecipe;
     constructor(resourceHandler: ResourceHandler, registriesPath: string, recipeOverrides: any);
     protected getRecipeNameUnlocalized(): string;
-    protected serializeRecipe(recipe: IRecipeCrafting, context: ISerializeContext, fileWriter: IFileWriter, serializer: HtmlInfoBookSerializer): string;
+    protected serializeRecipe(recipe: IRecipeCrafting, context: ISerializeContext, fileWriter: IFileWriter, serializer: HtmlInfoBookSerializer): Promise<string>;
 }
 export interface IRecipeCrafting extends IRecipe {
     id: string;

package/lib/infobook/appendix/InfoBookAppendixHandlerCraftingRecipe.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.InfoBookAppendixHandlerCraftingRecipe = void 0;
+const tslib_1 = require("tslib");
 const pug_1 = require("pug");
 const InfoBookAppendixHandlerAbstractRecipe_1 = require("./InfoBookAppendixHandlerAbstractRecipe");
 /**
@@ -15,35 +16,37 @@ class InfoBookAppendixHandlerCraftingRecipe extends InfoBookAppendixHandlerAbstr
         return 'block.minecraft.crafting_table';
     }
     serializeRecipe(recipe, context, fileWriter, serializer) {
-        // Prepare input array
-        const inputs = "|".repeat(9).split("|").map(() => []);
-        // Define custom dimensions for shapeless recipes
-        if (!recipe.width || !recipe.height) {
-            recipe.width = recipe.height = Math.sqrt(recipe.input.length);
-        }
-        // Format items in  grid
-        for (let x = 0; x < 3; x++) {
-            for (let y = 0; y < 3; y++) {
-                let items;
-                if (x < recipe.width && y < recipe.height) {
-                    const inputIndex = y * recipe.width + x;
-                    items = recipe.input[inputIndex] || [];
-                }
-                else {
-                    items = [];
-                }
-                if (!items.length) {
-                    items.push({ item: 'minecraft:air' });
-                }
-                const outputIndex = y * 3 + x;
-                for (const item of items) {
-                    inputs[outputIndex].push(serializer.createItemDisplay(this.resourceHandler, context, fileWriter, item, true));
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            // Prepare input array
+            const inputs = "|".repeat(9).split("|").map(() => []);
+            // Define custom dimensions for shapeless recipes
+            if (!recipe.width || !recipe.height) {
+                recipe.width = recipe.height = Math.sqrt(recipe.input.length);
+            }
+            // Format items in  grid
+            for (let x = 0; x < 3; x++) {
+                for (let y = 0; y < 3; y++) {
+                    let items;
+                    if (x < recipe.width && y < recipe.height) {
+                        const inputIndex = y * recipe.width + x;
+                        items = recipe.input[inputIndex] || [];
+                    }
+                    else {
+                        items = [];
+                    }
+                    if (!items.length) {
+                        items.push({ item: 'minecraft:air' });
+                    }
+                    const outputIndex = y * 3 + x;
+                    for (const item of items) {
+                        inputs[outputIndex].push(yield serializer.createItemDisplay(this.resourceHandler, context, fileWriter, item, true));
+                    }
                 }
             }
-        }
-        const output = serializer.createItemDisplay(this.resourceHandler, context, fileWriter, recipe.output, true);
-        const appendixIcon = serializer.createItemDisplay(this.resourceHandler, context, fileWriter, { item: 'minecraft:crafting_table' }, false);
-        return this.templateCraftingRecipe({ inputs, output, appendixIcon });
+            const output = yield serializer.createItemDisplay(this.resourceHandler, context, fileWriter, recipe.output, true);
+            const appendixIcon = yield serializer.createItemDisplay(this.resourceHandler, context, fileWriter, { item: 'minecraft:crafting_table' }, false);
+            return this.templateCraftingRecipe({ inputs, output, appendixIcon });
+        });
     }
 }
 exports.InfoBookAppendixHandlerCraftingRecipe = InfoBookAppendixHandlerCraftingRecipe;

package/lib/infobook/appendix/InfoBookAppendixHandlerImage.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.InfoBookAppendixHandlerImage = void 0;
+const tslib_1 = require("tslib");
 const fs_1 = require("fs");
 const path_1 = require("path");
 /**
@@ -15,10 +16,10 @@ class InfoBookAppendixHandlerImage {
         const fileName = path_1.basename(data._);
         const { width, height } = data.$;
         return {
-            toHtml: (context, fileWriter) => {
-                const writtenPath = fileWriter.write(fileName, fs_1.createReadStream(fullPath));
+            toHtml: (context, fileWriter) => tslib_1.__awaiter(this, void 0, void 0, function* () {
+                const writtenPath = yield fileWriter.write(fileName, () => fs_1.createReadStream(fullPath));
                 return `<canvas class="appendix-image" style="background: url(${writtenPath}); width: ${width * 2}px; height: ${height * 2}px; background-size: 512px 512px;"></canvas>`;
-            },
+            }),
         };
     }
 }

package/lib/infobook/appendix/InfoBookAppendixHandlerKeybinding.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.InfoBookAppendixHandlerKeybinding = void 0;
+const tslib_1 = require("tslib");
 const pug_1 = require("pug");
 /**
  * Handles keybindings appendices.
@@ -15,10 +16,10 @@ class InfoBookAppendixHandlerKeybinding {
         const key = this.resourceHandler.getKeybinding(id);
         return {
             getName: (context) => this.resourceHandler.getTranslation(`infobook.cyclopscore.keybinding`, context.language),
-            toHtml: (context) => {
+            toHtml: (context) => tslib_1.__awaiter(this, void 0, void 0, function* () {
                 const name = this.resourceHandler.getTranslation(id, context.language);
                 return this.templateKeybinding({ name, key });
-            },
+            }),
         };
     }
 }

package/lib/infobook/appendix/InfoBookAppendixHandlerSmeltingRecipe.d.ts

@@ -10,7 +10,7 @@ export declare class InfoBookAppendixHandlerSmeltingRecipe extends InfoBookAppen
     private readonly templateFurnaceRecipe;
     constructor(resourceHandler: ResourceHandler, registriesPath: string, recipeOverrides: any);
     protected getRecipeNameUnlocalized(): string;
-    protected serializeRecipe(recipe: IRecipeSmelting, context: ISerializeContext, fileWriter: IFileWriter, serializer: HtmlInfoBookSerializer): string;
+    protected serializeRecipe(recipe: IRecipeSmelting, context: ISerializeContext, fileWriter: IFileWriter, serializer: HtmlInfoBookSerializer): Promise<string>;
 }
 export interface IRecipeSmelting extends IRecipe {
     input: IItem[];

package/lib/infobook/appendix/InfoBookAppendixHandlerSmeltingRecipe.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.InfoBookAppendixHandlerSmeltingRecipe = void 0;
+const tslib_1 = require("tslib");
 const pug_1 = require("pug");
 const InfoBookAppendixHandlerAbstractRecipe_1 = require("./InfoBookAppendixHandlerAbstractRecipe");
 /**
@@ -15,10 +16,12 @@ class InfoBookAppendixHandlerSmeltingRecipe extends InfoBookAppendixHandlerAbstr
         return 'block.minecraft.furnace';
     }
     serializeRecipe(recipe, context, fileWriter, serializer) {
-        const input = recipe.input.map((item) => serializer.createItemDisplay(this.resourceHandler, context, fileWriter, item, true));
-        const output = serializer.createItemDisplay(this.resourceHandler, context, fileWriter, recipe.output, true);
-        const appendixIcon = serializer.createItemDisplay(this.resourceHandler, context, fileWriter, { item: 'minecraft:furnace' }, false);
-        return this.templateFurnaceRecipe({ input, output, appendixIcon });
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            const input = yield Promise.all(recipe.input.map((item) => serializer.createItemDisplay(this.resourceHandler, context, fileWriter, item, true)));
+            const output = yield serializer.createItemDisplay(this.resourceHandler, context, fileWriter, recipe.output, true);
+            const appendixIcon = yield serializer.createItemDisplay(this.resourceHandler, context, fileWriter, { item: 'minecraft:furnace' }, false);
+            return this.templateFurnaceRecipe({ input, output, appendixIcon });
+        });
     }
 }
 exports.InfoBookAppendixHandlerSmeltingRecipe = InfoBookAppendixHandlerSmeltingRecipe;

package/lib/infobook/appendix/InfoBookAppendixHandlerTextfield.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.InfoBookAppendixHandlerTextfield = void 0;
+const tslib_1 = require("tslib");
 /**
  * Handles text field appendices.
  */
@@ -14,9 +15,9 @@ class InfoBookAppendixHandlerTextfield {
             .replace(/\n/g, '<br \>');
         const scale = data.$.scale || 1;
         return {
-            toHtml: (context, fileWriter) => {
+            toHtml: (context, fileWriter) => tslib_1.__awaiter(this, void 0, void 0, function* () {
                 return `<div class="appendix-textfield" style="font-size: ${scale}em">${contents}</div>`;
-            },
+            }),
         };
     }
 }

package/lib/infobook/appendix/InfoBookAppendixTagIndex.d.ts

@@ -9,5 +9,5 @@ export declare class InfoBookAppendixTagIndex implements IInfoAppendix {
     private readonly resourceHandler;
     private readonly templateTagIndex;
     constructor(resourceHandler: ResourceHandler);
-    toHtml(context: ISerializeContext, fileWriter: IFileWriter, serializer: HtmlInfoBookSerializer): string;
+    toHtml(context: ISerializeContext, fileWriter: IFileWriter, serializer: HtmlInfoBookSerializer): Promise<string>;
 }

package/lib/infobook/appendix/InfoBookAppendixTagIndex.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.InfoBookAppendixTagIndex = void 0;
+const tslib_1 = require("tslib");
 const pug_1 = require("pug");
 /**
  * An appendix that lists all tags with links to them
@@ -11,26 +12,28 @@ class InfoBookAppendixTagIndex {
         this.templateTagIndex = pug_1.compileFile(__dirname + '/../../../template/appendix/tag_index.pug');
     }
     toHtml(context, fileWriter, serializer) {
-        const links = [];
-        for (const tag in context.sectionIndex.tags) {
-            const url = context.sectionIndex.tags[tag];
-            // First try localizing as item, and if that fails, as fluid
-            let icon;
-            const item = { item: tag };
-            let translationKey = this.resourceHandler.getItemTranslationKey(item);
-            if (translationKey) {
-                icon = serializer.createItemDisplay(this.resourceHandler, context, fileWriter, item, false);
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            const links = [];
+            for (const tag in context.sectionIndex.tags) {
+                const url = context.sectionIndex.tags[tag];
+                // First try localizing as item, and if that fails, as fluid
+                let icon;
+                const item = { item: tag };
+                let translationKey = this.resourceHandler.getItemTranslationKey(item);
+                if (translationKey) {
+                    icon = yield serializer.createItemDisplay(this.resourceHandler, context, fileWriter, item, false);
+                }
+                else {
+                    const fluid = { fluid: tag };
+                    translationKey = this.resourceHandler.getFluidTranslationKey(fluid);
+                    icon = yield serializer.createFluidDisplay(this.resourceHandler, context, fileWriter, fluid, false);
+                }
+                const name = this.resourceHandler.getTranslation(translationKey, context.language);
+                links.push({ url, name, icon });
             }
-            else {
-                const fluid = { fluid: tag };
-                translationKey = this.resourceHandler.getFluidTranslationKey(fluid);
-                icon = serializer.createFluidDisplay(this.resourceHandler, context, fileWriter, fluid, false);
-            }
-            const name = this.resourceHandler.getTranslation(translationKey, context.language);
-            links.push({ url, name, icon });
-        }
-        links.sort((link1, link2) => link1.name.localeCompare(link2.name));
-        return this.templateTagIndex({ links });
+            links.sort((link1, link2) => link1.name.localeCompare(link2.name));
+            return this.templateTagIndex({ links });
+        });
     }
 }
 exports.InfoBookAppendixTagIndex = InfoBookAppendixTagIndex;

package/lib/parse/XmlInfoBookParser.js

@@ -65,7 +65,7 @@ class XmlInfoBookParser {
             paragraphTranslationKeys: (data.paragraph || []).map((subData) => this.jsonToParagraph(subData)),
             appendix: ((data.appendix || []).concat(data.appendix_list || []))
                 .map((subData) => this.jsonToAppendix(subData, modId)),
-            tags: data.tag || [],
+            tags: (data.tag ? data.tag.filter((entry) => typeof entry === 'string') : undefined) || [],
             modId,
         };
         sections[section.nameTranslationKey] = section;

package/lib/resource/ResourceHandler.d.ts

@@ -6,6 +6,7 @@ import { IItem } from "../infobook/IItem";
 export declare class ResourceHandler {
     private static readonly TRANSLATION_DEFAULTS;
     private readonly translations;
+    private readonly languages;
     private readonly resourcePackBasePaths;
     private readonly iconsItem;
     private readonly itemTranslationKeys;
@@ -49,7 +50,7 @@ export declare class ResourceHandler {
      */
     addTranslations(language: string, translations: {
         [key: string]: string;
-    }): void;
+    }, excludedModLanguage: boolean): void;
     /**
      * Get the translation for the given key.
      * @param {string} translationKey A translation key.

package/lib/resource/ResourceHandler.js

@@ -8,6 +8,7 @@ const path_1 = require("path");
 class ResourceHandler {
     constructor() {
         this.translations = {};
+        this.languages = {};
         this.resourcePackBasePaths = {};
         this.iconsItem = {};
         this.itemTranslationKeys = {};
@@ -71,14 +72,14 @@ class ResourceHandler {
      * @returns {string[]} All available language keys.
      */
     getLanguages() {
-        return Object.keys(this.translations);
+        return Object.keys(this.languages);
     }
     /**
      * Add translations for the given language.
      * @param {string} language A language key.
      * @param {{[p: string]: string}} translations A mapping from translation key to translated value.
      */
-    addTranslations(language, translations) {
+    addTranslations(language, translations, excludedModLanguage) {
         language = language.toLowerCase();
         const existingTranslations = this.translations[language];
         if (!existingTranslations) {
@@ -89,6 +90,9 @@ class ResourceHandler {
                 existingTranslations[key] = translations[key];
             }
         }
+        if (!excludedModLanguage && Object.keys(translations).length > 0) {
+            this.languages[language] = true;
+        }
     }
     /**
      * Get the translation for the given key.

package/lib/resource/ResourceLoader.d.ts

@@ -33,7 +33,7 @@ export declare class ResourceLoader {
      * @param {string[]} paths An array of paths to traverse to look for resources.
      * @returns {Promise<void>} A promise resolving when loading is done.
      */
-    loadAll(baseDir: string, path: string): Promise<void>;
+    loadAll(baseDir: string, path: string, excludedModLanguages: string[]): Promise<void>;
     /**
      * Load a resource somewhere within the given path.
      *
@@ -42,21 +42,21 @@ export declare class ResourceLoader {
      * @param {string} fullPath A full path to look in.
      * @returns {Promise<void>} A promise resolving when loading is done.
      */
-    load(fullPath: string): Promise<void>;
+    load(fullPath: string, excludedModLanguages: string[]): Promise<void>;
     /**
      * Load the assets of the given pack.
      * @param {string} modid A mod id.
      * @param {string} fullPath The full path of the pack.
      * @returns {Promise<void>} A promise resolving when loading is done.
      */
-    loadAssets(modid: string, fullPath: string): Promise<void>;
+    loadAssets(modid: string, fullPath: string, excludedModLanguage: boolean): Promise<void>;
     /**
      * Load the language file within the given language folder.
      * @param {string} modid A mod id.
      * @param {string} langDir The full language directory path.
      * @returns {Promise<void>} A promise resolving when loading is done.
      */
-    loadAssetsLang(modid: string, langDir: string): Promise<void>;
+    loadAssetsLang(modid: string, langDir: string, excludedModLanguage: boolean): Promise<void>;
     /**
      * Load a single language file.
      * @param {string} modid A mod id.
@@ -64,7 +64,7 @@ export declare class ResourceLoader {
      * @param {string} fullFilePath The full language file path.
      * @returns {Promise<void>} A promise resolving when loading is done.
      */
-    loadAssetsLangFile(modid: string, language: string, fullFilePath: string): Promise<void>;
+    loadAssetsLangFile(modid: string, language: string, fullFilePath: string, excludedModLanguage: boolean): Promise<void>;
     /**
      * Load the advancements within the given folder, recursively.
      * @param {string} modid A mod id.

package/lib/resource/ResourceLoader.js

@@ -80,9 +80,9 @@ class ResourceLoader {
      * @param {string[]} paths An array of paths to traverse to look for resources.
      * @returns {Promise<void>} A promise resolving when loading is done.
      */
-    loadAll(baseDir, path) {
+    loadAll(baseDir, path, excludedModLanguages) {
         return tslib_1.__awaiter(this, void 0, void 0, function* () {
-            yield this.load(path_1.join(baseDir, path));
+            yield this.load(path_1.join(baseDir, path), excludedModLanguages);
         });
     }
     /**
@@ -93,14 +93,15 @@ class ResourceLoader {
      * @param {string} fullPath A full path to look in.
      * @returns {Promise<void>} A promise resolving when loading is done.
      */
-    load(fullPath) {
+    load(fullPath, excludedModLanguages) {
         return tslib_1.__awaiter(this, void 0, void 0, function* () {
             const entries = yield fs_1.promises.readdir(fullPath);
             // Look for a valid pack
             for (const modid of entries) {
+                const excludedModLanguage = excludedModLanguages.includes(modid);
                 const modPath = path_1.join(fullPath, modid);
                 if ((yield fs_1.promises.stat(modPath)).isDirectory()) {
-                    yield this.loadAssets(modid, modPath);
+                    yield this.loadAssets(modid, modPath, excludedModLanguage);
                 }
             }
         });
@@ -111,7 +112,7 @@ class ResourceLoader {
      * @param {string} fullPath The full path of the pack.
      * @returns {Promise<void>} A promise resolving when loading is done.
      */
-    loadAssets(modid, fullPath) {
+    loadAssets(modid, fullPath, excludedModLanguage) {
         return tslib_1.__awaiter(this, void 0, void 0, function* () {
             // Set base path
             this.resourceHandler.setResourcePackBasePath(modid, fullPath);
@@ -119,7 +120,7 @@ class ResourceLoader {
             const langDir = path_1.join(fullPath, 'lang');
             try {
                 if ((yield fs_1.promises.stat(langDir)).isDirectory()) {
-                    yield this.loadAssetsLang(modid, langDir);
+                    yield this.loadAssetsLang(modid, langDir, excludedModLanguage);
                 }
             }
             catch (e) {
@@ -143,12 +144,12 @@ class ResourceLoader {
      * @param {string} langDir The full language directory path.
      * @returns {Promise<void>} A promise resolving when loading is done.
      */
-    loadAssetsLang(modid, langDir) {
+    loadAssetsLang(modid, langDir, excludedModLanguage) {
         return tslib_1.__awaiter(this, void 0, void 0, function* () {
             const entries = yield fs_1.promises.readdir(langDir);
             for (const entry of entries) {
                 const language = entry.substring(0, entry.indexOf('.'));
-                yield this.loadAssetsLangFile(modid, language, path_1.join(langDir, entry));
+                yield this.loadAssetsLangFile(modid, language, path_1.join(langDir, entry), excludedModLanguage);
             }
         });
     }
@@ -159,10 +160,10 @@ class ResourceLoader {
      * @param {string} fullFilePath The full language file path.
      * @returns {Promise<void>} A promise resolving when loading is done.
      */
-    loadAssetsLangFile(modid, language, fullFilePath) {
+    loadAssetsLangFile(modid, language, fullFilePath, excludedModLanguage) {
         return tslib_1.__awaiter(this, void 0, void 0, function* () {
             const translations = JSON.parse((yield fs_1.promises.readFile(fullFilePath)).toString('utf8'));
-            this.resourceHandler.addTranslations(language, translations);
+            this.resourceHandler.addTranslations(language, translations, excludedModLanguage);
         });
     }
     /**

package/lib/serialize/HtmlInfoBookSerializer.d.ts

@@ -26,8 +26,8 @@ export declare class HtmlInfoBookSerializer {
         link: string;
         linkTarget: string;
     };
-    createItemDisplay(resourceHandler: ResourceHandler, context: ISerializeContext, fileWriter: IFileWriter, item: IItem, slot: boolean, annotation?: string): string;
-    createFluidDisplay(resourceHandler: ResourceHandler, context: ISerializeContext, fileWriter: IFileWriter, fluid: IFluid, slot: boolean): string;
+    createItemDisplay(resourceHandler: ResourceHandler, context: ISerializeContext, fileWriter: IFileWriter, item: IItem, slot: boolean, annotation?: string): Promise<string>;
+    createFluidDisplay(resourceHandler: ResourceHandler, context: ISerializeContext, fileWriter: IFileWriter, fluid: IFluid, slot: boolean): Promise<string>;
     tagFluid(context: ISerializeContext, fluidName: string): string;
     getLanguagePath(language: string, path?: string): string;
     /**

package/lib/serialize/HtmlInfoBookSerializer.js

@@ -97,23 +97,26 @@ class HtmlInfoBookSerializer {
                     if (context.googleAdsense && language === 'en_us') {
                         appendices.unshift(new InfoBookAppendixAd_1.InfoBookAppendixAd());
                     }
-                    // Create leaf file
-                    const fileContents = this.templateSection(Object.assign(Object.assign({}, context), { breadcrumbs, headSuffix: context.headSuffixGetters.map((g) => g(context)).join(''), languages,
-                        nextPage,
-                        previousPage, sectionAppendices: appendices
-                            .filter((appendix) => appendix) // TODO: rm
-                            .map((appendix) => {
-                            const appendixContents = appendix.toHtml(context, this.fileWriter, this);
+                    const sectionAppendices = [];
+                    for (const appendix of appendices) {
+                        if (appendix) {
+                            const appendixContents = yield appendix.toHtml(context, this.fileWriter, this);
                             if (appendix.skipWrapper) {
-                                return appendixContents;
+                                sectionAppendices.push(appendixContents);
                             }
                             else {
-                                return this.appendixWrapper({
+                                sectionAppendices.push(this.appendixWrapper({
                                     appendixContents,
                                     appendixName: appendix.getName ? appendix.getName(context) : null,
-                                });
+                                }));
                             }
-                        }), sectionParagraphs: section.paragraphTranslationKeys
+                        }
+                    }
+                    // Create leaf file
+                    const fileContents = this.templateSection(Object.assign(Object.assign({}, context), { breadcrumbs, headSuffix: context.headSuffixGetters.map((g) => g(context)).join(''), languages,
+                        nextPage,
+                        previousPage,
+                        sectionAppendices, sectionParagraphs: section.paragraphTranslationKeys
                             .map((key) => context.resourceHandler.getTranslation(key, context.language))
                             .map((value) => this.formatString(value)), sectionTitle }));
                     yield fs_1.promises.writeFile(filePath, fileContents);
@@ -174,35 +177,39 @@ class HtmlInfoBookSerializer {
         return { link, linkTarget };
     }
     createItemDisplay(resourceHandler, context, fileWriter, item, slot, annotation = '') {
-        if (item.item === 'minecraft:air') {
-            return slot ? '<div class="item item-slot">&nbsp;</div>' : '<div class="item">&nbsp;</div>';
-        }
-        const icon = resourceHandler.getItemIconFile(item.item, item.components);
-        if (!icon) {
-            throw new Error(`Could not find an icon for item ${JSON.stringify(item)}`);
-        }
-        const iconUrl = fileWriter.write('icons/' + path_1.basename(icon), fs_1.createReadStream(icon));
-        const key = resourceHandler.getItemTranslationKey(item);
-        if (!key) {
-            throw new Error(`Could not find translation key for item ${JSON.stringify(item)}`);
-        }
-        const { link, linkTarget } = this.createResourceLink(resourceHandler, context, item.item, key);
-        return this.templateItem(Object.assign(Object.assign({}, context), { annotation, count: item.count || 1, icon: iconUrl, link,
-            linkTarget, name: resourceHandler.getTranslation(resourceHandler.getItemTranslationKey(item), context.language), slot }));
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            if (item.item === 'minecraft:air') {
+                return slot ? '<div class="item item-slot">&nbsp;</div>' : '<div class="item">&nbsp;</div>';
+            }
+            const icon = resourceHandler.getItemIconFile(item.item, item.components);
+            if (!icon) {
+                throw new Error(`Could not find an icon for item ${JSON.stringify(item)}`);
+            }
+            const iconUrl = yield fileWriter.write('icons/' + path_1.basename(icon), () => fs_1.createReadStream(icon));
+            const key = resourceHandler.getItemTranslationKey(item);
+            if (!key) {
+                throw new Error(`Could not find translation key for item ${JSON.stringify(item)}`);
+            }
+            const { link, linkTarget } = this.createResourceLink(resourceHandler, context, item.item, key);
+            return this.templateItem(Object.assign(Object.assign({}, context), { annotation, count: item.count || 1, icon: iconUrl, link,
+                linkTarget, name: resourceHandler.getTranslation(resourceHandler.getItemTranslationKey(item), context.language), slot }));
+        });
     }
     createFluidDisplay(resourceHandler, context, fileWriter, fluid, slot) {
-        const icon = resourceHandler.getFluidIconFile(fluid.fluid);
-        if (!icon) {
-            throw new Error(`Could not find an icon for fluid ${JSON.stringify(fluid)}`);
-        }
-        const iconUrl = fileWriter.write('icons/' + path_1.basename(icon), fs_1.createReadStream(icon));
-        const key = resourceHandler.getFluidTranslationKey(fluid);
-        if (!key) {
-            throw new Error(`Could not find translation key for fluid ${JSON.stringify(fluid)}`);
-        }
-        const { link, linkTarget } = this.createResourceLink(resourceHandler, context, this.tagFluid(context, fluid.fluid), key);
-        return this.templateItem(Object.assign(Object.assign({}, context), { count: (fluid.amount || 1), icon: iconUrl, link,
-            linkTarget, name: resourceHandler.getTranslation(resourceHandler.getFluidTranslationKey(fluid), context.language), slot }));
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            const icon = resourceHandler.getFluidIconFile(fluid.fluid);
+            if (!icon) {
+                throw new Error(`Could not find an icon for fluid ${JSON.stringify(fluid)}`);
+            }
+            const iconUrl = yield fileWriter.write('icons/' + path_1.basename(icon), () => fs_1.createReadStream(icon));
+            const key = resourceHandler.getFluidTranslationKey(fluid);
+            if (!key) {
+                throw new Error(`Could not find translation key for fluid ${JSON.stringify(fluid)}`);
+            }
+            const { link, linkTarget } = this.createResourceLink(resourceHandler, context, this.tagFluid(context, fluid.fluid), key);
+            return this.templateItem(Object.assign(Object.assign({}, context), { count: (fluid.amount || 1), icon: iconUrl, link,
+                linkTarget, name: resourceHandler.getTranslation(resourceHandler.getFluidTranslationKey(fluid), context.language), slot }));
+        });
     }
     tagFluid(context, fluidName) {
         return fluidName;
@@ -229,6 +236,7 @@ class HtmlInfoBookSerializer {
         value = value.replace(/§o([^§]*)§r/g, '<em>$1</em>');
         value = value.replace(/§N/g, '<br />');
         // Colors to HTML
+        value = value.replace(/§r([^§]*)§0/g, '<span style="color: #000000">$1</span>');
         value = value.replace(/§1([^§]*)§0/g, '<span style="color: #0000AA">$1</span>');
         value = value.replace(/§2([^§]*)§0/g, '<span style="color: #00AA00">$1</span>');
         value = value.replace(/§3([^§]*)§0/g, '<span style="color: #00AAAA">$1</span>');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cyclops-infobook-html",
-  "version": "4.0.0",
+  "version": "5.0.0",
   "description": "Output Cyclops infobooks as HTML",
   "main": "index.js",
   "repository": "git@github.com:CyclopsMC/infobook-html.git",

package/CHANGELOG.md

@@ -1,83 +0,0 @@
-# Changelog
-All notable changes to this project will be documented in this file.
-
-<a name="v4.0.0"></a>
-## [v4.0.0](https://github.com/CyclopsMC/infobook-html/compare/v3.0.0...v4.0.0) - 2024-07-23
-
-### BREAKING CHANGE
-* [Update to NeoForge 1.21](https://github.com/CyclopsMC/infobook-html/commit/bec55a8a0d2049a07cc3dafee2276c94ed738e73)
-    The most notable change here is that "nbt" on items and fluids is replaced by "components".
-
-<a name="v3.1.0"></a>
-## [v3.1.0](https://github.com/CyclopsMC/infobook-html/compare/v3.0.0...v3.1.0) - 2024-01-31
-
-### Added
-* [Support text field appendix](https://github.com/CyclopsMC/infobook-html/commit/6f24bbbd606b6cfd1237e3bf740e73ffc23008be)
-* [Allowing raw mod URLs in modpack](https://github.com/CyclopsMC/infobook-html/commit/11c9ed5adc554ae7dafa66a202ac83fcacd240fb)
-
-<a name="v3.0.0"></a>
-## [v3.0.0](https://github.com/CyclopsMC/infobook-html/compare/v2.0.0...v3.0.0) - 2022-03-10
-
-### Changed
-* [Update to MC 1.18](https://github.com/CyclopsMC/infobook-html/commit/1fb77959593a2b84cb14e56406f0df20ad450e16)
-
-<a name="v2.0.0"></a>
-## [v2.0.0](https://github.com/CyclopsMC/infobook-html/compare/v1.1.2...v2.0.0) - 2021-02-03
-
-### Changed
-* [Update to MC 1.16](https://github.com/CyclopsMC/infobook-html/commit/249b211cb524414db95e3600dcdf14d9304926db)
-* [Also extract mod data](https://github.com/CyclopsMC/infobook-html/commit/c11023465f93c2018deaa10e14270102398dfb2a)
-* [Update footer year](https://github.com/CyclopsMC/infobook-html/commit/c946bab5c16c293b8a6a01a1c7ee1eb9c28b0ad6)
-  
-### Fixed
-* [Fix incorrect dumpregistries command](https://github.com/CyclopsMC/infobook-html/commit/90bf5675f8a71170e36e91d41c01d5ec94fab430)
-* [Fix server start failing after install in a hacky way](https://github.com/CyclopsMC/infobook-html/commit/03319253969e45b76d98b7b918bbf493c5985693)
-
-<a name="v1.1.2"></a>
-## [v1.1.2](https://github.com/CyclopsMC/infobook-html/compare/v1.1.1...v1.1.2) - 2019-07-31
-
-### Fixed
-* [Fix some URLs ending with two slashes](https://github.com/CyclopsMC/infobook-html/commit/8bb6b5f2efaa5babdbb0365258a911e82121ec74)
-
-<a name="v1.1.1"></a>
-## [v1.1.1](https://github.com/CyclopsMC/infobook-html/compare/v1.1.0...v1.1.1) - 2019-07-31
-
-### Added
-* [Allow baseUrl to be overridden via CLI](https://github.com/CyclopsMC/infobook-html/commit/c0090fd3fedc664cb33049bef5bc7e27225cb2b8)
-
-### Fixed
-* [Fix _lang dirs not being served on GitHub pages](https://github.com/CyclopsMC/infobook-html/commit/bb0c7bda1a8081322d1192ff293bbee1bdb411b0)
-* [Fix language links not resolving to baseIRI](https://github.com/CyclopsMC/infobook-html/commit/e87eb5a8cf5e5a1651350dfc49923503e3badb7e)
-* [Always end directory URLs with a slash](https://github.com/CyclopsMC/infobook-html/commit/9185cefa713e2d07783ff1f9b800926e24af8a8e)
-
-<a name="v1.1.0"></a>
-## [v1.1.0](https://github.com/CyclopsMC/infobook-html/compare/v1.0.1...v1.1.0) - 2019-07-29
-
-### Added
-* [Add furnace recipe handler](https://github.com/CyclopsMC/infobook-html/commit/7b6f2728c47283ed4c2e7a29da17a59af91be8bd)
-* [Add support for combined formatting codes and newlines](https://github.com/CyclopsMC/infobook-html/commit/47a857e5a42465fa27c08ad0473065118cfa6fac)
-* [Add support for predefined crafting recipes](https://github.com/CyclopsMC/infobook-html/commit/ecc794b36be7cdb2e7835723d62e729e9d89a629)
-
-### Fixed
-* [Fix item icons not being selected based on nbt](https://github.com/CyclopsMC/infobook-html/commit/1fe8f2938af881cc1a8911ccce4dafeaf6a9e25f)
-* [Fix too many ad blocks being added](https://github.com/CyclopsMC/infobook-html/commit/5db0b9321116c710ced4cb9a6bcbfb2de0224324)
-
-### Changed
-* [Make page controls slightly smaller](https://github.com/CyclopsMC/infobook-html/commit/c2bd0167b93eeab8e8feb343e5e3f8a0634c8379)
-* [Add support for multiple crafting recipes](https://github.com/CyclopsMC/infobook-html/commit/232f4c293564c818ce73b278b665282f12a7e4d7)
-* [Make templateItem field public](https://github.com/CyclopsMC/infobook-html/commit/dd22d9bbfa3ac6d2b7e9aa6c3eb2e98d91e45556)
-* [Throw error when translation keys are not found](https://github.com/CyclopsMC/infobook-html/commit/904c82275a84a3027b25660c0d87581d16decd43)
-* [Throw error if predefined is not found](https://github.com/CyclopsMC/infobook-html/commit/43cac0f927e5f8c5dbc05312e6008fe7ea96b345)
-* [Handle tagged crafting recipes](https://github.com/CyclopsMC/infobook-html/commit/d6d2dc821a868e790bc229da035c546a5b3e8ade)
-* [Exit with non-zero exit code on error](https://github.com/CyclopsMC/infobook-html/commit/33e3ef8fee72fc72d5608ddb865c53c91b24f59c)
-
-<a name="v1.0.1"></a>
-## [v1.0.1](https://github.com/CyclopsMC/infobook-html/compare/v1.0.0...v1.0.1) - 2019-07-25
-
-### Fixed
-* [Package assets](https://github.com/CyclopsMC/infobook-html/commit/1d6eda2f7618a7fb312427481f90528dd07185c9)
-
-<a name="v1.0.0"></a>
-## [v1.0.0] - 2019-06-25
-
-Initial release