v4.0.0-RC1 (#232)

* new zip library, first test.

* fix test name

* Add extra benchmark bits

* Finish ditch of admzip

* de-duplicate

* Begin code documentation

* more code doc

* small tweaks to l10n to make it slightly more efficient

* Make clean cache more visual

* More docs.

* more doc

* more docs

* more doc

* armor this better

* more doc.

* add JSON export (and fix a game.xml error)

* More JSON export work

* Update modAssist_func_lib.js

* Add extra error checking for local save manager

* Test build outside main branch? (if so, 4.0.0-alpha1

* add visual indicator of running dev copy.

* Update translations.

* Fix icons on light-mode displays. (bad check) #222

* Fix removing an external site record. #222

* Add "Select All" to simple cut/copy/paste context menu

* Update icons (fill types)

* Missed a few.

* update background for dev mode

* Track window scroll when editing folders.  Re: #228

* Fix tooltips on removing collection

* Add game.xml backup option.

* make backup every time we read it successfully (game.xml)

* Add backup option for gameSettings.xml too

* Add a few crops to the calendar

* Update dependencies. Closes #229

* Fix some test

* Bump to 3.9.72 (4.0.0-alpha2)

* Upstream translation merge - also clears #231

* Fix map PDA images.

* Fix folder based mods.

* add special alert for altering details of the active collection.

* Add JSON collection import feature

* Update dependencies

* Bump to 3.9.81 (4.0.0-beta1)

* Update ru.json

* Fix collection color import.

* Add documentation for collection import/export

* bump packages.

.gitignore

@@ -14,3 +14,4 @@ test/bgBuilder/*
 .VSCodeCounter
 TEST_OUTPUT.md
 .deepl_key
+jsdoc_server/

.jsdoc.json

@@ -0,0 +1,22 @@
+{
+    "tags": {
+        "allowUnknownTags": false
+    },
+    "source": {
+        "include": ["./modAssist_main.js", "./lib"]
+    },
+    "plugins": [
+        "plugins/markdown"
+    ],
+    "opts": {
+        "template": "node_modules/docdash/",
+        "encoding": "utf8",
+        "destination": "jsdoc_server/",
+        "recurse": true,
+        "verbose": true
+    },
+    "templates": {
+        "cleverLinks": false,
+        "monospaceLinks": false
+    }
+}

.vscode/settings.json

@@ -68,6 +68,7 @@
 		"deepl",
 		"DESCVERSION",
 		"digestate",
+		"docdash",
 		"dollys",
 		"drygrass",
 		"DXGI",
@@ -123,6 +124,7 @@
 		"iconfilename",
 		"IMAGEFILENAME",
 		"IMAGENAME",
+		"importjson",
 		"incomeperhour",
 		"ingame",
 		"inputbinding",
@@ -205,6 +207,7 @@
 		"progressbar",
 		"pycache",
 		"reallights",
+		"redcabbage",
 		"Rescan",
 		"roadsalt",
 		"Rottne",
@@ -214,6 +217,7 @@
 		"savedate",
 		"savegame",
 		"savegamename",
+		"savegames",
 		"savemanage",
 		"savetrack",
 		"SCCS",
@@ -255,6 +259,7 @@
 		"Vicon",
 		"wheelconfiguration",
 		"wheelconfigurations",
+		"whitecabbage",
 		"windrowers",
 		"woodchips",
 		"workingwidth",

docs/importexport.md

@@ -61,3 +61,65 @@ Next to each collection is a small `CSV` icon <i class="bi bi-filetype-csv"></i>
 You can drag single mods from the collection area to any valid target in windows.  Valid targets are the desktop, an explorer window, and any number of third party apps that support dragging a file directly to them (for example, Discord)
 
 ![Alt text](img340/drag-drop-export.png)
+
+## Import & Export of Collections
+
+There is support for importing and exporting collection settings.
+
+### Export Collection
+
+Right click on the collection, and choose "Export Settings (JSON)"
+
+![context](img340/context-collection.png)
+
+---
+
+### Altering Export Details
+
+The import / export JSON format is defined below. Most of the options are directly from the collection detail settings, the two additional fields are available for single mod download (no unzip) and mod pack download (unzip) at import time.
+
+```json
+{
+    "collection_color": 6,
+    "collection_description": "Test Import Server",
+    "download_direct": [
+        "https://example.net/my_mod_collection.zip"
+    ],
+    "download_unzip": [
+        "https://example.net/FS22_SingleMod.zip"
+    ],
+    "force_frozen": true,
+    "game_version": 22,
+    "server_downloads": false,
+    "server_id": "1-2-3-4",
+    "server_name": "server-name",
+    "server_password": "server-join-password",
+    "server_website": "http://example.net/"
+}
+```
+
+---
+
+### Import Collection
+
+To import a collection drag-and-drop the JSON file to the Mod Assistant window.  A New window will appear
+
+The first section of the window will give you an overview of the collection being imported.
+
+![overview](img340/import-step-0.png)
+
+#### Step 1
+
+First, select where on disk you would like to store the collection.  You can use an existing folder (for instance, if updating a collection, or you already made the folder), or, you can create a new folder in the dialog that appears.
+
+![step 1](img340/import-step-1.png)
+
+Once you have selected the folder, press the "Apply Settings" button to apply the included settings.  The button becomes enabled after selecting a location, and turns green when it is finished.
+
+#### Step 2 (optional)
+
+Optionally, you can include one-time downloads in an exported collection JSON file - if you do, they are available to download here.  The buttons become available once you have selected a location on disk to store the collection.  The buttons turn green when they are finished.  Please note that these downloads will overwrite any existing files.
+
+![step 2](img340/import-step-2.png)
+
+Mod pack style downloads will be unzipped after download, single mods will just be stored in the collection folder.