Mod Support - 1.5.0 Update (#1361)

* initial modloader draft

* modloader features

* Refactor mods to use signals

* Add support for modifying and registering new transltions

* Minor adjustments

* Support for string building ids for mods

* Initial support for adding new buildings

* Refactor how mods are loaded to resolve circular dependencies and prepare for future mod loading

* Lazy Load mods to make sure all dependencies are loaded

* Expose all exported members automatically to mods

* Fix duplicate exports

* Allow loading mods from standalone

* update changelog

* Fix mods folder incorrect path

* Fix modloading in standalone

* Fix sprites not getting replaced, update demo mod

* Load dev mod via raw loader

* Improve mod developing so mods are directly ready to be deployed, load mods from local file server

* Proper mods ui

* Allow mods to register game systems and draw stuff

* Change mods path

* Fix sprites not loading

* Minor adjustments, closes #1333

* Add support for loading atlases via mods

* Add support for loading mods from external sources in DEV

* Add confirmation when loading mods

* Fix circular dependency

* Minor Keybindings refactor, add support for keybindings to mods, add support for dialogs to mods

* Add some mod signals

* refactor game loading states

* Make shapez exports global

* Start to make mods safer

* Refactor file system electron event handling

* Properly isolate electron renderer process

* Update to latest electron

* Show errors when loading mods

* Update confirm dialgo

* Minor restructure, start to add mod examples

* Allow adding custom themesw

* Add more examples and allow defining custom item processor operations

* Add interface to register new buildings

* Fixed typescript type errors (#1335)

* Refactor building registry, make it easier for mods to add new buildings

* Allow overriding existing methods

* Add more examples and more features

* More mod examples

* Make mod loading simpler

* Add example how to add custom drawings

* Remove unused code

* Minor modloader adjustments

* Support for rotation variants in mods (was broken previously)

* Allow mods to replace builtin sub shapes

* Add helper methods to extend classes

* Fix menu bar on mac os

* Remember window state

* Add support for paste signals

* Add example how to add custom components and systems

* Support for mod settings

* Add example for adding a new item type

* Update class extensions

* Minor adjustments

* Fix typo

* Add notification blocks mod example

* Add small tutorial

* Update readme

* Add better instructions

* Update JSDoc for Replacing Methods (#1336)

* upgraded types for overriding methods

* updated comments

Co-authored-by: Edward Badel <you@example.com>

* Direction lock now indicates when there is a building inbetween

* Fix mod examples

* Fix linter error

* Game state register (#1341)

* Added a gamestate register helper

Added a gamestate register helper

* Update mod_interface.js

* export build options

* Fix runBeforeMethod and runAfterMethod

* Minor game system code cleanup

* Belt path drawing optimization

* Fix belt path optimization

* Belt drawing improvements, again

* Do not render belts in statics disabled view

* Allow external URL to load more than one mod (#1337)

* Allow external URL to load more than one mod

Instead of loading the text returned from the remote server, load a JSON object with a `mods` field, containing strings of all the mods. This lets us work on more than one mod at a time or without separate repos. This will break tooling such as `create-shapezio-mod` though.

* Update modloader.js

* Prettier fixes

* Added link to create-shapezio-mod npm page (#1339)

Added link to create-shapezio-mod npm page: https://www.npmjs.com/package/create-shapezio-mod

* allow command line switch to load more than one mod (#1342)

* Fixed class handle type (#1345)

* Fixed class handle type

* Fixed import game state

* Minor adjustments

* Refactor item acceptor to allow only single direction slots

* Allow specifying minimumGameVersion

* Add sandbox example

* Replaced concatenated strings with template literals (#1347)

* Mod improvements

* Make wired pins component optional on the storage

* Fix mod examples

* Bind `this` for method overriding JSDoc (#1352)

* fix entity debugger reaching HTML elements (#1353)

* Store mods in savegame and show warning when it differs

* Closes #1357

* Fix All Shapez Exports Being Const (#1358)

* Allowed setting of variables inside webpack modules

* remove console log

* Fix stringification of things inside of eval

Co-authored-by: Edward Badel <you@example.com>

* Fix building placer intersection warning

* Add example for storing data in the savegame

* Fix double painter bug (#1349)

* Add example on how to extend builtin buildings

* update readme

* Disable steam achievements when playing with mods

* Update translations

Co-authored-by: Thomas (DJ1TJOO) <44841260+DJ1TJOO@users.noreply.github.com>
Co-authored-by: Bagel03 <70449196+Bagel03@users.noreply.github.com>
Co-authored-by: Edward Badel <you@example.com>
Co-authored-by: Emerald Block <69981203+EmeraldBlock@users.noreply.github.com>
Co-authored-by: saile515 <63782477+saile515@users.noreply.github.com>
Co-authored-by: Sense101 <67970865+Sense101@users.noreply.github.com>

src/js/platform/api.js

@@ -3,7 +3,6 @@ import { Application } from "../application";
 /* typehints:end */
 import { createLogger } from "../core/logging";
 import { compressX64 } from "../core/lzstring";
-import { getIPCRenderer } from "../core/utils";
 import { T } from "../translations";
 
 const logger = createLogger("puzzle-api");
@@ -113,9 +112,7 @@ export class ClientAPI {
             return Promise.resolve({ token });
         }
 
-        const renderer = getIPCRenderer();
-
-        return renderer.invoke("steam:get-ticket").then(
+        return ipcRenderer.invoke("steam:get-ticket").then(
             ticket => {
                 logger.log("Got auth ticket:", ticket);
                 return this._request("/v1/public/login", {

src/js/platform/electron/steam_achievement_provider.js

@@ -4,7 +4,6 @@ import { GameRoot } from "../../game/root";
 /* typehints:end */
 
 import { createLogger } from "../../core/logging";
-import { getIPCRenderer } from "../../core/utils";
 import { ACHIEVEMENTS, AchievementCollection, AchievementProviderInterface } from "../achievement_provider";
 
 const logger = createLogger("achievements/steam");
@@ -109,9 +108,7 @@ export class SteamAchievementProvider extends AchievementProviderInterface {
             return Promise.resolve();
         }
 
-        this.ipc = getIPCRenderer();
-
-        return this.ipc.invoke("steam:is-initialized").then(initialized => {
+        return ipcRenderer.invoke("steam:is-initialized").then(initialized => {
             this.initialized = initialized;
 
             if (!this.initialized) {
@@ -136,7 +133,7 @@ export class SteamAchievementProvider extends AchievementProviderInterface {
         if (!this.initialized) {
             promise = Promise.resolve();
         } else {
-            promise = this.ipc.invoke("steam:activate-achievement", ACHIEVEMENT_IDS[key]);
+            promise = ipcRenderer.invoke("steam:activate-achievement", ACHIEVEMENT_IDS[key]);
         }
 
         return promise

src/js/platform/electron/storage.js

@@ -1,30 +1,8 @@
-import { StorageInterface } from "../storage";
-import { getIPCRenderer } from "../../core/utils";
-import { createLogger } from "../../core/logging";
-
-const logger = createLogger("electron-storage");
+import { FILE_NOT_FOUND, StorageInterface } from "../storage";
 
 export class StorageImplElectron extends StorageInterface {
     constructor(app) {
         super(app);
-
-        /** @type {Object.<number, {resolve:Function, reject: Function}>} */
-        this.jobs = {};
-        this.jobId = 0;
-
-        getIPCRenderer().on("fs-response", (event, arg) => {
-            const id = arg.id;
-            if (!this.jobs[id]) {
-                logger.warn("Got unhandled FS response, job not known:", id);
-                return;
-            }
-            const { resolve, reject } = this.jobs[id];
-            if (arg.result.success) {
-                resolve(arg.result.data);
-            } else {
-                reject(arg.result.error);
-            }
-        });
     }
 
     initialize() {
@@ -32,44 +10,32 @@ export class StorageImplElectron extends StorageInterface {
     }
 
     writeFileAsync(filename, contents) {
-        return new Promise((resolve, reject) => {
-            // ipcMain
-            const jobId = ++this.jobId;
-            this.jobs[jobId] = { resolve, reject };
-
-            getIPCRenderer().send("fs-job", {
-                type: "write",
-                filename,
-                contents,
-                id: jobId,
-            });
+        return ipcRenderer.invoke("fs-job", {
+            type: "write",
+            filename,
+            contents,
         });
     }
 
     readFileAsync(filename) {
-        return new Promise((resolve, reject) => {
-            // ipcMain
-            const jobId = ++this.jobId;
-            this.jobs[jobId] = { resolve, reject };
-
-            getIPCRenderer().send("fs-job", {
+        return ipcRenderer
+            .invoke("fs-job", {
                 type: "read",
                 filename,
-                id: jobId,
+            })
+            .then(res => {
+                if (res && res.error === FILE_NOT_FOUND) {
+                    throw FILE_NOT_FOUND;
+                }
+
+                return res;
             });
-        });
     }
 
     deleteFileAsync(filename) {
-        return new Promise((resolve, reject) => {
-            // ipcMain
-            const jobId = ++this.jobId;
-            this.jobs[jobId] = { resolve, reject };
-            getIPCRenderer().send("fs-job", {
-                type: "delete",
-                filename,
-                id: jobId,
-            });
+        return ipcRenderer.invoke("fs-job", {
+            type: "delete",
+            filename,
         });
     }
 }

src/js/platform/electron/wrapper.js

@@ -1,6 +1,5 @@
 import { NoAchievementProvider } from "../browser/no_achievement_provider";
 import { PlatformWrapperImplBrowser } from "../browser/wrapper";
-import { getIPCRenderer } from "../../core/utils";
 import { createLogger } from "../../core/logging";
 import { StorageImplElectron } from "./storage";
 import { SteamAchievementProvider } from "./steam_achievement_provider";
@@ -71,15 +70,13 @@ export class PlatformWrapperImplElectron extends PlatformWrapperImplBrowser {
     }
 
     initializeDlcStatus() {
-        const renderer = getIPCRenderer();
-
         if (G_WEGAME_VERSION) {
             return Promise.resolve();
         }
 
         logger.log("Checking DLC ownership ...");
         // @todo: Don't hardcode the app id
-        return renderer.invoke("steam:check-app-ownership", 1625400).then(
+        return ipcRenderer.invoke("steam:check-app-ownership", 1625400).then(
             res => {
                 logger.log("Got DLC ownership:", res);
                 this.dlcs.puzzle = Boolean(res);
@@ -106,7 +103,7 @@ export class PlatformWrapperImplElectron extends PlatformWrapperImplBrowser {
     }
 
     setFullscreen(flag) {
-        getIPCRenderer().send("set-fullscreen", flag);
+        ipcRenderer.send("set-fullscreen", flag);
     }
 
     getSupportsAppExit() {
@@ -115,6 +112,6 @@ export class PlatformWrapperImplElectron extends PlatformWrapperImplBrowser {
 
     exitApp() {
         logger.log(this, "Sending app exit signal");
-        getIPCRenderer().send("exit-app");
+        ipcRenderer.send("exit-app");
     }
 }