Update docs for 5.0.0

FSGModding · Aug 20, 2024 · f200178 · f200178
1 parent 562e6be
commit f200178
Show file tree

Hide file tree

Showing 47 changed files with 44 additions and 70 deletions.
diff --git a/docs/basegame.md b/docs/basegame.md
@@ -4,7 +4,7 @@
 
 ## Overview
 
-Sometimes you just need to know what base game equipment is available without going into the game.  Mod Assitant has you covered.  Open it with the <i class="bi bi-wikipedia"></i> icon in the top bar
+Sometimes you just need to know what base game equipment is available without going into the game.  Mod Assistant has you covered for FS22, FS19, and shortly after release, FS25.  Open it with the <i class="bi bi-wikipedia"></i> icon in the top bar
 
 ![overview](img340/main-window-part-top-bar.png)
 

diff --git a/docs/collections.md b/docs/collections.md
@@ -64,7 +64,7 @@ Most of the collection buttons are covered in other sections, most notably in:
 - [Savegame Compare](savegame.html)
 - [Import and Export](importexport.html)
 
-Not mentioned in any of those is the first icon in this sample - this collection only contains a single map, so the map icon is shown, and clicking it will load the mod detail screen for that map.
+Not mentioned in any of those is the first icon in this sample - if a collection only contains a single map, the map icon is shown, and clicking it will load the mod detail screen for that map.  If multiple maps are in a collection, a dropdown selection will appear.
 
 ![Active collection](img340/collection-entry.png)
 
@@ -90,4 +90,4 @@ Sometimes you have changed the active collection in the dropdown list but either
 
 ![Alt text](img340/collection-mismatch.png)
 
-You can ignore the warning, or set the currently selected mod set as active.  Note that you will have to press the `Launch Game` button again when the process is finished.
+You can ignore the warning, or set the currently selected mod set as active and launch the game (new in 5.0.0, the game will launch after the collection is marked active)
diff --git a/docs/comparetool.md b/docs/comparetool.md
@@ -10,4 +10,4 @@ This is a tool to compare multiple items to each other.  It is available in mult
 
 Here, you will find sortable columns for price, maximum and minimum engine power (or power requirement as applicable), max speed or implement speed limit, working width, weight, and fill capacity.
 
-The small red trashcan removes an item from the list.
+The small red trashcan removes an item from the list. Use the top button to clear the list.  Generally, items are saved in the list until you explicitly remove them - the list is cleared automatically if you change game versions though.
diff --git a/docs/details.md b/docs/details.md
@@ -62,7 +62,7 @@ This option marks a collection as being on removable storage.  When set as remov
 
 #### Version
 
-This sets the game version the collection is associated with.  It will always be preset to the version you are currently working with in Mod Assistant, or, if you do not have multi-version support enabled, it will be set to 2022
+This sets the game version the collection is associated with.  It will always be preset to the version you are currently working with in Mod Assistant.
 
 #### In-Game Units
 

diff --git a/docs/fileoper.md b/docs/fileoper.md
@@ -18,7 +18,6 @@ For better display, paths are shortened, hover over the path to see the full pat
 
 ![movecopy](img340/movecopy-single.png)
 
-
 ## Move or Copy - Multiple Collections (Dropbox)
 
 Moving or copying files **from a dropbox collection** brings up a confirmation window.  Choose a destination to and press the `Yes` button to continue.  Exiting files will be automatically overwritten.

diff --git a/docs/filter.md b/docs/filter.md
@@ -10,7 +10,11 @@ The filter bar allows you to filter your mod collections
 
 ## Limit To field
 
-This field allows you to limit to the mods that are displayed. This is a full text search of the Name, Title, and author field of the mod.  You can use an exclamation mark `!` at the beginning of the line to search for mods that *do not* match the string.  Note that this will not filter out currently selected mods.
+This field allows you to limit to the mods that are displayed. This is a full text search of the Name, Title, and author field of the mod.  You can use an exclamation mark `!` at the beginning of the line to search for mods that *do not* match the string.  Note that this will not filter out currently selected mods.  If you require more specific searching, you can use the dropdown to search only on title, author, or file name.
+
+## Mod Sorting
+
+By default, mods are shown sorted by their filename.  The sort feature allows you to order by Title, Author, Version, or File Date (oldest first)
 
 ## Hide Tags and Limit to Tags
 
@@ -22,8 +26,10 @@ For more information about what the tags mean, see the [Collection Area](mods.ht
 
 This list is built dynamically from your mod set, so only those tags that exist in your collections will be provided.
 
-The green open eye __shows__ mods with that tag in the list, while the orange closed eye __hides__ mods with that tag from the list.
+The green open eye indicates that mods __MAY__ have that tag.
+
+The orange closed eye indicates that mods __MAY NOT__ have that tag.
 
-The red pin is special, it will show the mod __only__ if the mod has that tag.
+The red pin is special and indicates that that mods __MUST__ have that tag.
 
 For instance, you could use the red pin on "map" and "recent", then the orange closed eye on "issue" to show only map type mods that have been recently updated, but not any that have detected issues.
diff --git a/docs/gamelog.md b/docs/gamelog.md
@@ -23,3 +23,5 @@ The buttons on the right side, from left to right are:
 - Clear the log file.  This will clear the contents of the opened log file. Particularly useful if you are using command line flags that prevent the log from resetting itself on game launch.
 
 Searching is provided, along with a number of filter buttons.  Of note, the "duplicates" button is off by default - that means the duplicate lines (with no different items between them) will be suppressed and a count bubble will be presented to the left of that line instead of showing it multiple times.  Click this filter to suppress this behavior.
+
+New in 5.0.0, if your log is less than 5,000 lines, the scrollbar will be overlaid with orange for warnings and red for errors to assist in finding problems quickly.  This line limit may change in future versions as this feature is performance limiting.
diff --git a/docs/img340/active-collection.png b/docs/img340/active-collection.png
diff --git a/docs/img340/basegame-cats.png b/docs/img340/basegame-cats.png
diff --git a/docs/img340/basegame-detail.png b/docs/img340/basegame-detail.png
diff --git a/docs/img340/basegame-list.png b/docs/img340/basegame-list.png
diff --git a/docs/img340/basegame-notreal.png b/docs/img340/basegame-notreal.png
diff --git a/docs/img340/collection-dropbox.png b/docs/img340/collection-dropbox.png
diff --git a/docs/img340/collection-entry.png b/docs/img340/collection-entry.png
diff --git a/docs/img340/collection-favorite.png b/docs/img340/collection-favorite.png
diff --git a/docs/img340/collection-manage.png b/docs/img340/collection-manage.png
diff --git a/docs/img340/comparetool.png b/docs/img340/comparetool.png
diff --git a/docs/img340/delete-single.png b/docs/img340/delete-single.png
diff --git a/docs/img340/drag-drop-import-zip.png b/docs/img340/drag-drop-import-zip.png
diff --git a/docs/img340/drag-drop-import.png b/docs/img340/drag-drop-import.png
diff --git a/docs/img340/game-log.png b/docs/img340/game-log.png
diff --git a/docs/img340/hide-limit-tags.png b/docs/img340/hide-limit-tags.png
diff --git a/docs/img340/main-screen.png b/docs/img340/main-screen.png
diff --git a/docs/img340/main-window-part-collect-manage.png b/docs/img340/main-window-part-collect-manage.png
diff --git a/docs/img340/main-window-part-mod-filter.png b/docs/img340/main-window-part-mod-filter.png
diff --git a/docs/img340/main-window-part-mod-list.png b/docs/img340/main-window-part-mod-list.png
diff --git a/docs/img340/main-window-part-side-bar.png b/docs/img340/main-window-part-side-bar.png
diff --git a/docs/img340/main-window-part-top-bar.png b/docs/img340/main-window-part-top-bar.png
diff --git a/docs/img340/mod-detail-main.png b/docs/img340/mod-detail-main.png
diff --git a/docs/img340/mod-entry-dark.png b/docs/img340/mod-entry-dark.png
diff --git a/docs/img340/mod-list.png b/docs/img340/mod-list.png
diff --git a/docs/img340/movecopy-favorite.png b/docs/img340/movecopy-favorite.png
diff --git a/docs/img340/movecopy-multi.png b/docs/img340/movecopy-multi.png
diff --git a/docs/img340/movecopy-single.png b/docs/img340/movecopy-single.png
diff --git a/docs/img340/pref-advanced.png b/docs/img340/pref-advanced.png
diff --git a/docs/img340/pref-game-22.png b/docs/img340/pref-game-22.png
diff --git a/docs/img340/pref-game-multi.png b/docs/img340/pref-game-multi.png
diff --git a/docs/img340/pref-game.png b/docs/img340/pref-game.png
diff --git a/docs/img340/wizard-step-002.png b/docs/img340/wizard-step-002.png
diff --git a/docs/img340/wizard-step-003.png b/docs/img340/wizard-step-003.png
diff --git a/docs/img340/wizard-step-004.png b/docs/img340/wizard-step-004.png
diff --git a/docs/importexport.md b/docs/importexport.md
@@ -30,7 +30,7 @@ You will be presented with a dialog where you can choose to copy the files to on
 
 ### Drag-and-Drop Import Package
 
-If you have exported a mod collection (or part of one), those ZIP files are specially detected by Mod Assistant and will unzip their contents on import.
+If you have exported a mod collection (or part of one), those ZIP files are specially detected by Mod Assistant and will unzip their contents on import. New in 5.0.0, you can preview the files that will be unpacked.
 
 ![drag in confirm](img340/drag-drop-import-zip.png)
 
@@ -64,7 +64,19 @@ You can drag single mods from the collection area to any valid target in windows
 
 ## Import & Export of Collections
 
-There is support for importing and exporting collection settings.
+There is support for importing and exporting collection settings.  Drag the exported JSON collection file to Mod Assistant. A popup will appear with the settings contained
+
+![step 1](img340/import-step-0.png)
+
+Next, pick a folder location for the new collection.  The popup allows you to create a new folder directly if needed.  Press `Apply Settings` if you are happy with your selection
+
+![step 2](img340/import-step-1.png)
+
+Finally, if the JSON provider as added download links to get the collection started, you can download those files here.
+
+![step 3](img340/import-step-2.png)
+
+This is a very new feature, and may change in the future.  If you want to be able to provide a JSON import for your users, the best bet is to join our discord for more information on how to set up the file.
 
 ### Export Collection
 

diff --git a/docs/index.md b/docs/index.md
@@ -36,7 +36,6 @@ Please note that this documentation is auto-generated, and may refer to a newer
 - [Comparison Tool](comparetool.html)
 - [User Preferences](preferences.html)
 - [Game Log Viewer](gamelog.html)
-- [Multiple Game Version Mode](multi-version.html)
 - [FSG Bot Integration HowTo](fsgbot.html)
 - [Frequently Asked Questions](faq.html)
 
@@ -84,7 +83,7 @@ Either download the new version and install over top, or, the program will self-
 
 ### Mod Assistant Speed
 
-__PLEASE READ: Note about the Mod Cache:__ Mods are scanned and cached from disk so that this app can run as fast as possible - but the initial scanning process is in depth, and ___not very fast___.  So, be aware than when you add a folder of a lot of mods, it may take a bit of time to scan them for the first time. Mod Assistant goes out of it's way to only scan a "version" of a file once, so subsequent loads on the program will be much, much fast.  If you are interested in the details of the cache, see the FAQ. If you find that your collections continue to full rescan, you may need to enable sync mode - see the page on [User Preferences](preferences.html)
+__PLEASE READ: Note about the Mod Cache:__ Mods are scanned and cached from disk so that this app can run as fast as possible - but the initial scanning process is in depth, and ___not very fast___.  So, be aware than when you add a folder of a lot of mods, it may take a bit of time to scan them for the first time. Mod Assistant goes out of it's way to only scan a "version" of a file once, so subsequent loads on the program will be much, much faster.  If you are interested in the details of the cache, see the FAQ. If you find that your collections continue to full rescan, you may need to enable sync mode - see the page on [User Preferences](preferences.html)
 
 ## Translations and Localizations
 

diff --git a/docs/multi-version.md b/docs/multi-version.md
diff --git a/docs/preferences.md b/docs/preferences.md
@@ -46,12 +46,11 @@ Sometimes, your windows may get to be odd sizes, or open in odd places.  These s
 
 ## Game Options
 
-![display](img340/pref-game-22.png)
+![display](img340/pref-game.png)
 
 ### Multiple Version Mode
 
-Mod Assistant is capable of working with more than one version of Farming Simulator at the same time.  We currently support `FS22`, `FS19`, `FS17`, `FS15`, and `FS13`.  At this time, there are no plans to support earlier versions, nor will any attempt be made at supporting any mobile version.  You can learn more about this feature in the [Multiple Game Version Mode](multi-version.html) documentation.
-
+As of version 5.0.0, multiple version mode is always on.
 
 ### Game Path Settings
 
@@ -81,12 +80,12 @@ In some cases, if you synchronize your mods with multiple computers, Mod Assista
 
 ### Poll Game Status
 
-When enabled, this will update the Mod Assistant interface to indicate if the game is currently running.  This is only applicable to Farming Simulator 22
+When enabled, this will update the Mod Assistant interface to indicate if the game is currently running. This follows the current version.
 
 ### Discord Rich Presence
 
 If you'd like Mod Assistant to update your discord presence (desktop app only), you can set that up here. You can also set 2 custom status lines here. This is on by default.
 
 ### Mod Cache
 
-The Mod Cache is how Mod Assistant is able to keep track of your mod files.  If you have removed a lot of mod files over time, it may be a good idea to `Clean Cache`, or, when upgrading between major versions, `Clear Cache` can help. In the example image, my mod collection is around 500 files, and this was after rebuilding the cache after the 2.0.0 upgrade. The `Clear Detail Cache` is a safe option if you have altered a mod and the store data is out-of-date. Note that the detail cache auto-expires over time.
+The Mod Cache is how Mod Assistant is able to keep track of your mod files.  If you have removed a lot of mod files over time, it may be a good idea to `Clean Cache`, or, when upgrading between major versions, `Clear Cache` can help. In the example image, my mod collection is around 500 files, and this was after rebuilding the cache after the 2.0.0 upgrade. The `Clear Detail Cache` is a safe option if you have altered a mod and the store data is out-of-date. Note that the detail cache auto-expires over time. Finally, use `Clear User-Defined Malware Ignore List` to reset any possible bad mods you have ignored the warning for.
diff --git a/docs/wizard.md b/docs/wizard.md
@@ -12,19 +12,19 @@ The first step is for the simple things - it lets you set the display font size,
 
 ## Step 2
 
-Next, we need some basic details about where Farming Simulator 2022 is installed.  Mod Assistant will do it's best to find your settings file and game exe.
+Next, we need some basic details about where Farming Simulator 2022 and/or 2025 is installed.  Mod Assistant will do it's best to find your settings file and game exe.
 
 If you see an option that looks good, and the button isn't already green with a thumbs up, go ahead and press it.
 
-Mod Assistant can find FS2022 in the default eShop install, the default Epic Games install, any steam folder, and the default MS/XBox store install location.  If it fails, you'll need to locate the game manually.
+Mod Assistant can find Farm Sim in the default eShop install, the default Epic Games install, any steam folder, and the default MS/XBox store install location.  If it fails, you'll need to locate the game manually.
 
 If more than one install is found, they will all be presented as options.
 
 ![001](img340/wizard-step-002.png)
 
 ## Step 3
 
-A lot of new users of Mod Assistant are already using mod collections, they are just doing it the hard way.  In step 3, if MA sees a bunch of `.ZIP` files in your mods folder, it will offer to add it as a collection.  If it sees a bunch of folders in there that __do not__ start with `FS22`, it will offer to add those as collections.
+A lot of new users of Mod Assistant are already using mod collections, they are just doing it the hard way.  In step 3, if MA sees a bunch of `.ZIP` files in your mods folder, it will offer to add it as a collection.  If it sees a bunch of folders in there that __do not__ start with `FS`, it will offer to add those as collections.  New in 5.0.0, it will search for previous version mod folders as well - the version mod assistant things a collection for is denoted by the icon at the beginning of the line
 
 ![001](img340/wizard-step-003.png)
 

diff --git a/renderer/jsconfig.json b/renderer/jsconfig.json
@@ -4,5 +4,10 @@
 	  "target": "ES2023"
 	},
 	"include": ["renderJS/util/*.js", "renderJS/*.js", "preload/**/*"],
-	"exclude": ["node_modules/**/*"],
+	"exclude": [
+		"node_modules",
+		"renderer/renderJS/inc/**/*.js",
+		"renderer/renderJS/util/baseGameData.js",
+		"renderer/renderJS/util/baseGameData19.js"
+	],
 }
Original file line number	Diff line number	Diff line change
Expand Up		@@ -10,4 +10,4 @@ This is a tool to compare multiple items to each other. It is available in mult

		Here, you will find sortable columns for price, maximum and minimum engine power (or power requirement as applicable), max speed or implement speed limit, working width, weight, and fill capacity.

		The small red trashcan removes an item from the list.
		The small red trashcan removes an item from the list. Use the top button to clear the list. Generally, items are saved in the list until you explicitly remove them - the list is cleared automatically if you change game versions though.
Original file line number	Diff line number	Diff line change
Expand Up		@@ -18,7 +18,6 @@ For better display, paths are shortened, hover over the path to see the full pat

		![movecopy](img340/movecopy-single.png)


		## Move or Copy - Multiple Collections (Dropbox)

		Moving or copying files from a dropbox collection brings up a confirmation window. Choose a destination to and press the `Yes` button to continue. Exiting files will be automatically overwritten.
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -23,3 +23,5 @@ The buttons on the right side, from left to right are:
		- Clear the log file. This will clear the contents of the opened log file. Particularly useful if you are using command line flags that prevent the log from resetting itself on game launch.

		Searching is provided, along with a number of filter buttons. Of note, the "duplicates" button is off by default - that means the duplicate lines (with no different items between them) will be suppressed and a count bubble will be presented to the left of that line instead of showing it multiple times. Click this filter to suppress this behavior.

		New in 5.0.0, if your log is less than 5,000 lines, the scrollbar will be overlaid with orange for warnings and red for errors to assist in finding problems quickly. This line limit may change in future versions as this feature is performance limiting.