cyclops-infobook-html 3.0.0 → 4.0.0

package/CHANGELOG.md

@@ -1,6 +1,20 @@
 # 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
 

package/README.md

@@ -44,11 +44,18 @@ Before you can execute this phase, you need a `modpack.json` file with contents
 	  "type": "maven",
       "artifact": "org.cyclops.commoncapabilities:CommonCapabilities:1.12.2-2.4.4-309",
       "repo": "https://oss.jfrog.org/artifactory/simple/libs-release/"
+    },
+    {
+      "type": "raw",
+      "name": "integratedscripting-1.19.2-1.0.0-61.jar",
+      "url": "https://www.dropbox.com/s/mbbikni5ieyttuq/integratedscripting-1.19.2-1.0.0-61.jar?dl=1"
     }
   ]
 }
 ```
 
+*The "forge" entry may be replaced by "neoforge".*
+
 To start this phase, simply run `generate-mod-metadata modpack.json generate`.
 
 Optionally, you can delete the resulting server files afterwards using `generate-mod-metadata modpack.json clean`.

package/assets/styles.css

@@ -167,6 +167,11 @@ hr {
     top: 1px;
 }
 
+.appendix-textfield {
+    text-align: left;
+    padding: 10px;
+}
+
 .appendix .inputs {
     display: inline-block;
     vertical-align: middle;

package/bin/generate-infobook-html.js

@@ -10,6 +10,7 @@ const InfoBookAppendixHandlerCraftingRecipe_1 = require("../lib/infobook/appendi
 const InfoBookAppendixHandlerSmeltingRecipe_1 = require("../lib/infobook/appendix/InfoBookAppendixHandlerSmeltingRecipe");
 const InfoBookAppendixHandlerImage_1 = require("../lib/infobook/appendix/InfoBookAppendixHandlerImage");
 const InfoBookAppendixHandlerKeybinding_1 = require("../lib/infobook/appendix/InfoBookAppendixHandlerKeybinding");
+const InfoBookAppendixHandlerTextfield_1 = require("../lib/infobook/appendix/InfoBookAppendixHandlerTextfield");
 const InfoBookInitializer_1 = require("../lib/infobook/InfoBookInitializer");
 const ResourceLoader_1 = require("../lib/resource/ResourceLoader");
 const HtmlInfoBookSerializer_1 = require("../lib/serialize/HtmlInfoBookSerializer");
@@ -61,6 +62,7 @@ function create() {
         infoBookInitializer.registerAppendixHandler('minecraft:smelting', new InfoBookAppendixHandlerSmeltingRecipe_1.InfoBookAppendixHandlerSmeltingRecipe(resourceLoader.getResourceHandler(), 'registries', config.recipeOverrides));
         infoBookInitializer.registerAppendixHandler('image', new InfoBookAppendixHandlerImage_1.InfoBookAppendixHandlerImage(resourceLoader.getResourceHandler()));
         infoBookInitializer.registerAppendixHandler('keybinding', new InfoBookAppendixHandlerKeybinding_1.InfoBookAppendixHandlerKeybinding(resourceLoader.getResourceHandler()));
+        infoBookInitializer.registerAppendixHandler('textfield', new InfoBookAppendixHandlerTextfield_1.InfoBookAppendixHandlerTextfield(resourceLoader.getResourceHandler()));
         // Load plugins
         const assetsPaths = [];
         const headSuffixGetters = [];

package/bin/generate-mod-metadata.js

@@ -18,7 +18,7 @@ function run(command, configPath) {
         const modLoader = new ModLoader_1.ModLoader({
             mods: config.mods,
             path: path_1.join(process.cwd(), 'server'),
-            versionForge: config.forge,
+            loader: 'forge' in config ? { versionForge: config.forge } : { versionNeoForge: config.neoforge },
             versionMinecraft: config.minecraft,
         });
         switch (command) {

package/lib/infobook/IItem.d.ts

@@ -1,5 +1,5 @@
 export interface IItem {
     item: string;
     count?: number;
-    nbt?: string;
+    components?: string;
 }

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

@@ -0,0 +1,11 @@
+import { ResourceHandler } from "../../resource/ResourceHandler";
+import { IInfoAppendix } from "../IInfoAppendix";
+import { IInfoBookAppendixHandler } from "./IInfoBookAppendixHandler";
+/**
+ * Handles text field appendices.
+ */
+export declare class InfoBookAppendixHandlerTextfield implements IInfoBookAppendixHandler {
+    private readonly resourceHandler;
+    constructor(resourceHandler: ResourceHandler);
+    createAppendix(data: any): IInfoAppendix;
+}

package/lib/infobook/appendix/InfoBookAppendixHandlerTextfield.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InfoBookAppendixHandlerTextfield = void 0;
+/**
+ * Handles text field appendices.
+ */
+class InfoBookAppendixHandlerTextfield {
+    constructor(resourceHandler) {
+        this.resourceHandler = resourceHandler;
+    }
+    createAppendix(data) {
+        const contents = data._
+            .replace(/ /g, ' ')
+            .replace(/\n/g, '<br \>');
+        const scale = data.$.scale || 1;
+        return {
+            toHtml: (context, fileWriter) => {
+                return `<div class="appendix-textfield" style="font-size: ${scale}em">${contents}</div>`;
+            },
+        };
+    }
+}
+exports.InfoBookAppendixHandlerTextfield = InfoBookAppendixHandlerTextfield;
+//# sourceMappingURL=InfoBookAppendixHandlerTextfield.js.map

package/lib/modloader/ModLoader.d.ts

@@ -6,7 +6,7 @@ import { ChildProcess } from "child_process";
 export declare class ModLoader {
     private readonly mods;
     private readonly path;
-    private readonly versionForge;
+    private readonly loader;
     private readonly versionMinecraft;
     constructor(args: IModLoaderArgs);
     /**
@@ -29,6 +29,7 @@ export declare class ModLoader {
      * Download and install mods.
      */
     installMods(): Promise<void>;
+    downloadFile(url: string, fileName: string, modsDir: string): Promise<void>;
     /**
      * Start the server and execute a command to dump all registries
      */
@@ -75,14 +76,20 @@ export declare class ModLoader {
 export interface IModLoaderArgs {
     mods: IMod[];
     path: string;
-    versionForge: string;
+    loader: ILoader;
     versionMinecraft: string;
 }
-export declare type IMod = IModMaven | IModCurseforge;
+export declare type ILoader = {
+    versionForge: string;
+} | {
+    versionNeoForge: string;
+};
+export declare type IMod = IModMaven | IModCurseforge | IModRaw;
 export interface IModMaven {
     type: 'maven';
     artifact: string;
     repo: string;
+    name?: string;
 }
 export interface IModCurseforge {
     type: 'curseforge';
@@ -90,3 +97,8 @@ export interface IModCurseforge {
     artifact: string;
     version: string;
 }
+export interface IModRaw {
+    type: 'raw';
+    name: string;
+    url: string;
+}

package/lib/modloader/ModLoader.js

@@ -20,7 +20,7 @@ class ModLoader {
     constructor(args) {
         this.mods = args.mods;
         this.path = args.path;
-        this.versionForge = args.versionForge;
+        this.loader = args.loader;
         this.versionMinecraft = args.versionMinecraft;
     }
     /**
@@ -37,22 +37,41 @@ class ModLoader {
             if (!fs.existsSync(this.path)) {
                 yield fs.promises.mkdir(this.path);
             }
-            // Download Forge installer
-            process.stdout.write('Downloading Forge...\n');
-            const forgeInstaller = `https://files.minecraftforge.net/maven/net/minecraftforge/forge/${this.versionMinecraft}-${this.versionForge}/forge-${this.versionMinecraft}-${this.versionForge}-installer.jar`;
-            const res = yield node_fetch_1.default(forgeInstaller);
-            if (!res.ok) {
-                throw new Error(`Failed to fetch (${res.statusText}): ${forgeInstaller}`);
+            let installerFile;
+            if ('versionForge' in this.loader) {
+                // Download Forge installer
+                process.stdout.write('Downloading Forge...\n');
+                const forgeInstaller = `https://files.minecraftforge.net/maven/net/minecraftforge/forge/${this.versionMinecraft}-${this.loader.versionForge}/forge-${this.versionMinecraft}-${this.loader.versionForge}-installer.jar`;
+                const res = yield node_fetch_1.default(forgeInstaller);
+                if (!res.ok) {
+                    throw new Error(`Failed to fetch (${res.statusText}): ${forgeInstaller}`);
+                }
+                installerFile = path_1.join(this.path, 'forge-installer.jar');
+                yield new Promise((resolve, reject) => tslib_1.__awaiter(this, void 0, void 0, function* () {
+                    return fs.writeFile(installerFile, yield res.buffer(), (err) => err ? reject(err) : resolve());
+                }));
+                // Install Forge
+                process.stdout.write('Installing Forge...\n');
+                yield new Promise((resolve, reject) => child_process_1.exec(`cd ${this.path} && java -jar forge-installer.jar --installServer`).on('exit', resolve));
+            }
+            else {
+                // Download NeoForge installer
+                process.stdout.write('Downloading NeoForge...\n');
+                const installer = `https://maven.neoforged.net/releases/net/neoforged/neoforge/${this.loader.versionNeoForge}/neoforge-${this.loader.versionNeoForge}-installer.jar`;
+                const res = yield node_fetch_1.default(installer);
+                if (!res.ok) {
+                    throw new Error(`Failed to fetch (${res.statusText}): ${installer}`);
+                }
+                installerFile = path_1.join(this.path, 'neoforge-installer.jar');
+                yield new Promise((resolve, reject) => tslib_1.__awaiter(this, void 0, void 0, function* () {
+                    return fs.writeFile(installerFile, yield res.buffer(), (err) => err ? reject(err) : resolve());
+                }));
+                // Install Forge
+                process.stdout.write('Installing NeoForge...\n');
+                yield new Promise((resolve, reject) => child_process_1.exec(`cd ${this.path} && java -jar neoforge-installer.jar --installServer`).on('exit', resolve));
             }
-            const installerFile = path_1.join(this.path, 'forge-installer.jar');
-            yield new Promise((resolve, reject) => tslib_1.__awaiter(this, void 0, void 0, function* () {
-                return fs.writeFile(installerFile, yield res.buffer(), (err) => err ? reject(err) : resolve());
-            }));
-            // Install Forge
-            process.stdout.write('Installing Forge...\n');
-            yield new Promise((resolve, reject) => child_process_1.exec(`cd ${this.path} && java -jar forge-installer.jar --installServer`).on('exit', resolve));
             // Wait a bit, because otherwise some files don't exist yet (while they should...)
-            process.stdout.write('Wait a bit after Forge installation...\n');
+            process.stdout.write('Wait a bit after mod loader installation...\n');
             yield new Promise((resolve) => setTimeout(resolve, 10000));
             // Cleanup
             process.stdout.write('Cleaning up...\n');
@@ -91,20 +110,19 @@ class ModLoader {
                     process.stdout.write(`  - ${fileName} from CurseForge...\n`);
                     const url = `https://minecraft.curseforge.com/api/maven/${mod.project}/${mod.artifact
                         .replace(/-/g, '/')}/${fileName}`;
-                    const response = yield node_fetch_1.default(url);
-                    if (response.status !== 200) {
-                        throw new Error(response.statusText + ' on ' + url);
-                    }
-                    yield new Promise((resolve, reject) => {
-                        response.body
-                            .on('error', reject)
-                            .on('end', resolve)
-                            .pipe(fs.createWriteStream(path_1.join(modsDir, fileName)));
-                    });
+                    yield this.downloadFile(url, fileName, modsDir);
                 }
                 else if (mod.type === 'maven') {
                     process.stdout.write(`  - ${mod.artifact} from ${mod.repo}...\n`);
-                    yield mvn_artifact_download_1.default(mod.artifact, modsDir, mod.repo);
+                    const name = yield mvn_artifact_download_1.default(mod.artifact, modsDir, mod.repo);
+                    // Rename file if needed
+                    if ('name' in mod) {
+                        fs.renameSync(name, path_1.join(modsDir, mod.name));
+                    }
+                }
+                else if (mod.type === 'raw') {
+                    process.stdout.write(`  - ${mod.name} from ${mod.url}...\n`);
+                    yield this.downloadFile(mod.url, mod.name, modsDir);
                 }
                 else {
                     throw new Error('Unknown mod type ' + mod.type);
@@ -112,6 +130,20 @@ class ModLoader {
             }
         });
     }
+    downloadFile(url, fileName, modsDir) {
+        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+            const response = yield node_fetch_1.default(url);
+            if (response.status !== 200) {
+                throw new Error(response.statusText + ' on ' + url);
+            }
+            yield new Promise((resolve, reject) => {
+                response.body
+                    .on('error', reject)
+                    .on('end', resolve)
+                    .pipe(fs.createWriteStream(path_1.join(modsDir, fileName)));
+            });
+        });
+    }
     /**
      * Start the server and execute a command to dump all registries
      */
@@ -135,7 +167,7 @@ class ModLoader {
             });
             // Once the loading is complete, send our command and stop the server
             proc.stdout.on('data', (line) => {
-                if (line.indexOf('[Server thread/INFO]: Done') >= 0) {
+                if (line.indexOf('Done') >= 0 && line.indexOf('For help, type "help"') >= 0) {
                     process.stdout.write('Dumping registries...\n');
                     this.sendCommand(proc, '/cyclopscore dumpregistries');
                     this.sendCommand(proc, '/stop');

package/lib/resource/ResourceHandler.js

@@ -179,7 +179,7 @@ class ResourceHandler {
      */
     addItemTranslationKey(item, translationKey) {
         const { namespace, path } = ResourceHandler.splitItemId(item.item);
-        ResourceHandler.addItemKeyedRegistryEntry(this.itemTranslationKeys, namespace, path, item.nbt, translationKey);
+        ResourceHandler.addItemKeyedRegistryEntry(this.itemTranslationKeys, namespace, path, item.components, translationKey);
     }
     /**
      * Get an item translation key.
@@ -188,7 +188,7 @@ class ResourceHandler {
      */
     getItemTranslationKey(item) {
         const { namespace, path } = ResourceHandler.splitItemId(item.item);
-        return ResourceHandler.getItemKeyedRegistryEntry(this.itemTranslationKeys, namespace, path, item.nbt);
+        return ResourceHandler.getItemKeyedRegistryEntry(this.itemTranslationKeys, namespace, path, item.components);
     }
     /**
      * Add an fluid translation key.

package/lib/resource/ResourceLoader.js

@@ -126,7 +126,7 @@ class ResourceLoader {
                 // Ignore mods without language files
             }
             // Handle advancements
-            const advancementsDir = path_1.join(fullPath, 'advancements');
+            const advancementsDir = path_1.join(fullPath, 'advancement');
             try {
                 if ((yield fs_1.promises.stat(langDir)).isDirectory()) {
                     yield this.loadAssetsAdvancements(modid, advancementsDir, '');

package/lib/serialize/HtmlInfoBookSerializer.js

@@ -177,7 +177,7 @@ class HtmlInfoBookSerializer {
         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.nbt);
+        const icon = resourceHandler.getItemIconFile(item.item, item.components);
         if (!icon) {
             throw new Error(`Could not find an icon for item ${JSON.stringify(item)}`);
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cyclops-infobook-html",
-  "version": "3.0.0",
+  "version": "4.0.0",
   "description": "Output Cyclops infobooks as HTML",
   "main": "index.js",
   "repository": "git@github.com:CyclopsMC/infobook-html.git",
@@ -50,13 +50,13 @@
     "testEnvironment": "node"
   },
   "devDependencies": {
-    "@types/jest": "^26.0.0",
+    "@types/jest": "^28.0.0",
     "@types/minimist": "^1.2.0",
     "coveralls": "^3.0.3",
-    "jest": "^26.0.0",
+    "jest": "^28.0.0",
     "manual-git-changelog": "^1.0.1",
     "pre-commit": "^1.2.2",
-    "ts-jest": "^26.0.0",
+    "ts-jest": "^28.0.0",
     "tslint": "^6.0.0",
     "tslint-eslint-rules": "^5.4.0",
     "typescript": "^4.0.0"
@@ -90,5 +90,8 @@
     "rimraf": "^3.0.0",
     "xml2js": "^0.4.19",
     "yauzl": "^2.10.0"
+  },
+  "resolutions": {
+    "@types/istanbul-reports": "3.0.0"
   }
 }