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>

translations/base-en.yaml

@@ -126,6 +126,11 @@ mainMenu:
     puzzleDlcWishlist: Wishlist now!
     puzzleDlcViewNow: View Dlc
 
+    mods:
+        title: Active Mods
+        warningPuzzleDLC: >-
+            Playing the Puzzle DLC is not possible with mods. Please disable all mods to play the DLC.
+
 puzzleMenu:
     play: Play
     edit: Edit
@@ -418,6 +423,14 @@ dialogs:
         desc: >-
             Are you sure you want to delete '<title>'? This can not be undone!
 
+    modsDifference:
+        title: Mod Warning
+        desc: >-
+            The currently installed mods differ from the mods the savegame was created with.
+            This might cause the savegame to break or not load at all. Are you sure you want to continue?
+        missingMods: Missing Mods
+        newMods: Newly installed Mods
+
 ingame:
     # This is shown in the top left corner and displays useful keybindings in
     # every situation
@@ -1086,6 +1099,24 @@ storyRewards:
         desc: >-
             You have reached the end of the demo version!
 
+mods:
+    title: Mods
+
+    author: Author
+    version: Version
+    modWebsite: Website
+    openFolder: Open Mods Folder
+    folderOnlyStandalone: Opening the mod folder is only possible when running the standalone.
+    browseMods: Browse Mods
+
+    modsInfo: >-
+        To install and manage mods, copy them to the mods folder within the game directory. You can also use the 'Open Mods Folder' button on the top right.
+    noModSupport: You need the standalone version on Steam to install mods.
+
+    togglingComingSoon:
+        title: Coming Soon
+        description: Enabling or disabling mods is currently only possible by copying the mod file from or to the mods/ folder. However, being able to toggle them here is planned for a future update!
+
 settings:
     title: Settings
     categories:
@@ -1101,6 +1132,7 @@ settings:
     buildDate: Built <at-date>
     tickrateHz: <amount> Hz
     rangeSliderPercentage: <amount> %
+    newBadge: New!
 
     labels:
         uiScale:
@@ -1306,6 +1338,7 @@ keybindings:
         massSelect: Mass Select
         buildings: Building Shortcuts
         placementModifiers: Placement Modifiers
+        mods: Provided by Mods
 
     mappings:
         confirm: Confirm

translations/base-zh-CN.yaml

@@ -73,6 +73,9 @@ mainMenu:
     puzzleDlcText: 持续优化，追求极致效率。在限定空间内使用有限的设施来创造图形！《异形工厂》（Shapez.io）的首个DLC“谜题挑战者”将会给大家带来更烧脑、更自由的全新挑战！
     puzzleDlcWishlist: 添加愿望单！
     puzzleDlcViewNow: 查看DLC
+    mods:
+        title: 激活游戏模组（Mods）
+        warningPuzzleDLC: 无法在任何游戏模组（Mods）下进行“谜题挑战者”DLC，请关闭所有游戏模组（Mods）。
 dialogs:
     buttons:
         ok: 确认
@@ -223,6 +226,13 @@ dialogs:
     puzzleDelete:
         title: 删除谜题？
         desc: 您是否确认删除 '<title>'？删除后不可恢复！
+    modsDifference:
+        title: Mod Warning
+        desc: The currently installed mods differ from the mods the savegame was created
+            with. This might cause the savegame to break or not load at all. Are
+            you sure you want to continue?
+        missingMods: Missing Mods
+        newMods: Newly installed Mods
 ingame:
     keybindingsOverlay:
         moveMap: 移动地图
@@ -843,6 +853,7 @@ settings:
             description: 在设施上悬停时是否始终显示图形工具提示， 而不是必须按住“Alt”键。
     rangeSliderPercentage: <amount> %
     tickrateHz: <amount> 赫兹
+    newBadge: 新的！
 keybindings:
     title: 按键设定
     hint: 提示：使用 CTRL、SHIFT、ALT！这些键在放置设施时有不同的效果。
@@ -855,6 +866,7 @@ keybindings:
         massSelect: 批量选择
         buildings: 设施快捷键
         placementModifiers: 放置设施修饰键
+        mods: 由游戏模组（Mods）提供
     mappings:
         confirm: 确认
         back: 返回
@@ -1080,3 +1092,17 @@ backendErrors:
     timeout: 请求超时。
     too-many-likes-already: 您的谜题已经得到了许多玩家的赞赏。如果您仍然希望删除它，请联系support@shapez.io!
     no-permission: 您没有执行此操作的权限。
+mods:
+    title: 游戏模组（Mods）
+    author: 作者
+    version: 版本
+    openFolder: 打开游戏模组（Mods）文件夹
+    folderOnlyStandalone: 只有完整版才可以打开游戏模组（Mods）文件夹。
+    browseMods: 浏览游戏模组（Mods）
+    modsInfo: 要安装和管理游戏模组（Mods），请将它们复制到游戏目录中的mods文件夹。您也可以使用右上角的“打开Mods文件夹”按钮。
+    noModSupport: 您需要在Steam平台获得完整版才可以安装游戏模组（Mods）。
+    togglingComingSoon:
+        title: 即将开放
+        description: 当前只能通过将游戏模组（Mods）文件复制到mods文件夹或从mods文件夹移除来启用或禁用游戏模组（Mods）。
+            但是，可以切换游戏模组（Mods）已经计划在之后的更新中实现！
+    modWebsite: Website