Skip to content

Commit

Permalink
Update docs, bump to 1.2.0
Browse files Browse the repository at this point in the history
  • Loading branch information
jtsage committed Nov 15, 2022
1 parent 3b6a653 commit 626b53f
Show file tree
Hide file tree
Showing 19 changed files with 35 additions and 21 deletions.
29 changes: 22 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ ___Contents___
- [Detail Window](#detail-window)
- [Move and Copy](#move-and-copy)
- [Delete](#delete)
- [Copy Favorites](#copy-favorites)
- [Savegame Compare](#savegame-compare)
- [Badges Used](#badges-used)
- [Version Check](#version-check)
Expand Down Expand Up @@ -108,6 +109,7 @@ __PLEASE READ: Note about the Mod Cache:__ Mods are scanned and cached from disk

- __Check Versions__ : Compare mod versions across different collections and resolve differences if desired.
- __Launch FS22__ : Start the game. If your game is not in the default e-shop or steam location, you will need to set the game path in the preferences screen first.
- __Discord Join Button__ : Join the [Farm Sim Game Discord](http://fsg.gg) for a great farming & modding community, and help on this app if you need it.

#### Collections Area

Expand Down Expand Up @@ -146,38 +148,43 @@ The active list is marked with a green check over the folder.

- __Collection Checkbox__ : You can use this checkbox to quick select all or none of the mods in the list. Additionally, shift-select for a range of mods is available.
- __Compare to SaveGame__ : This will prompt you for a savegame (folder or zip file) and will compare what mods the save game expects to the mods in the collection.
- __Server Button__ : Open the server admin link in your default web browser
- __Download Button__ : Refresh all active mods from the server (if server download is configured and enabled)
- __Export Button__ : This allows you to export the collection as a CSV file containing the mod name, version, author, and if applicable, a link to the modhub page
- __Details Edit__ : This button brings up the collection details that will allow you to keep notes on the collection, and set your user name, password, and server name filter for multiplayer use.
- __Move To...__ : This will prompt you which collection you wish to move the selected files into. This button is only available when a one or more files are selected.
- __Copy To...__ : This will prompt you which collection you wish to copy the selected files into. This button is only available when a one or more files are selected.
- __Delete__ : This will prompt you to make sure you wish to delete the selected files. This button is only available when a one or more files are selected.
- __Show in Explorer__ : Open a windows explorer window with the selected file pre-selected. This button is only available when a single file is selected.
- __Find on ModHub__ : Attempt to open this mod on the modhub. This button is only available when a single file is selected, and Mod Assistant knows it is on the modhub. The list of mods is updated roughly hourly, and is refreshed when you restart the app.
- __Copy Favorites To...__ : Copy the contents of your favorite folder(s) to one or more other collections.

##### Search Feature

![collections search](screen_shots/005-collect_search.png)

This allows you to refine which parts of the collection you see. This is a simple full text search, however preceding the search string with `!` will show mods that do _not_ match the string. In this example, `FS22_25DU_Trailers` is still shown, even though it does not match the string, because it was selected prior to searching. This is a safety measure so you do not accidentally move, copy, or delete files you were not intending to.
This allows you to refine which parts of the collection you see. This is a simple full text search, however preceding the search string with `!` will show mods that do _not_ match the string. In this example, `FS22_25DU_Trailers` and `FS22_36ftLowLoader` is still shown, even though it does not match the string, because it was selected prior to searching. This is a safety measure so you do not accidentally move, copy, or delete files you were not intending to.

###### Search Buttons

- __Show Non-Mods__ : hides files that Mod Assistant thinks are not mods
- __Show Broken__ : hides mods that Mod Assistant believes are broken
- __Select None__ : Clear selection on this collection
- __Select All__ : Select all on this collection
- __Select Invert__ : Invert selection on this collection
- __Select None__ : Clear selection on this collection `SHIFT+CTRL+A`
- __Select All__ : Select all on this collection `CTRL+A`
- __Select Invert__ : Invert selection on this collection `CTRL+I`

### Folder Details Window

![folder detail](screen_shots/015-notes.png)

This screen allows you to keep notes on a collection, and set some of the multiplayer server details to speed things up.

- __Favorite Collection__ : Mark this collection as a set of "favorite" mods for quick copying to other collections.
- __Player Name__ : This is the name that is displayed in-game
- __Server Name__ : This value is pre-filled in the server list screen to filter
- __Server Password__ : This value is pre-filled in the password box when attempting to join a server that requires a password
- __Server Website__ : This is a place to keep the administration address for a multiplayer server.
- __Server Website__ : This is a place to keep the administration address for a multiplayer server. This should be in the format http(s)://server.url:port/ - do not include the "index.html" at the end.
- __Allow Direct Download__ : If this server has direct mod download enabled, check this box to let mod assistant download and replace all mods on demand.
- __Admin Password__ : This is a place to note the admin password for the server.
- __Notes__ : This is a freeform notes input

Expand All @@ -187,7 +194,7 @@ Keep in mind that all of these details are stored in ___plain text___ both in mo

![detail top](screen_shots/013-detail_top.png)

Double clicking or right clicking on a mod in the main window will bring up the detail window where you can see details about the mod such as the file date, file size, if it uses scripts, how many store items it has, and the mod description.
Double clicking or right clicking on a mod in the main window will bring up the detail window where you can see details about the mod such as the file date, file size, if it uses scripts, how many store items it has, and the mod description. If the mod is on the modhub, the most recent modhub version will appear, along with a link to open the modhub page in your default browser.

If problems or issues were found with the mod, you will also be presenting with detailed information on the issue, often with suggestions of how to fix them

Expand All @@ -207,6 +214,14 @@ In the move and copy dialog you will see a list of the selected mods, along with

In the delete dialog you will see a list of the selected mods. This is a permanent action, it directly deletes these files, bypassing the recycling bin. To proceed, press the button at the bottom, to cancel simply close the popup window or press `[ESC]`

### Copy Favorites

![copy fav](screen_shots/016-copyfavs.png)

This dialog is used to copy the contents of your favorite collection(s) to multiple non-favorite collections. Check the collections you with to copy to. This function will automatically overwrite files at the destination.

The lower part of the screen shows what mods were found in the favorite collection(s).

### Savegame Compare

![savegame](screen_shots/008-savegame.png)
Expand Down Expand Up @@ -242,7 +257,7 @@ Check the box next to old versions of mods and press the `Yes, Copy Mod(s)` butt

![folders](screen_shots/011-folders.png)

This display will let you change which collections are loaded, and open them in windows explorer if you wish. In this example, I have "forgotten" the `test_mods` collection, which will update when I close the folder edit window.
This display will let you change which collections are loaded, and open them in windows explorer if you wish. Use the arrow buttons to move a collection up, down, to the top, or bottom.

### User Preferences

Expand Down
Binary file modified README.pdf
Binary file not shown.
17 changes: 8 additions & 9 deletions modAssist_main.js
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,6 @@ if ( !gotTheLock ) { app.quit() }

const { autoUpdater } = require('electron-updater')
const { ma_logger } = require('./lib/ma-logger.js')
const mcDetail = require('./package.json')
const semverGt = require('semver/functions/gt')
const log = new ma_logger('modAssist', app, 'assist.log', gotTheLock)
const path = require('path')
Expand All @@ -27,7 +26,7 @@ const skipCache = false && !(app.isPackaged)
const crashLog = path.join(app.getPath('userData'), 'crash.log')
let updaterInterval = null

log.log.info(`ModAssist Logger: ${mcDetail.version}`)
log.log.info(`ModAssist Logger: ${app.getVersion()}`)

process.on('uncaughtException', (err, origin) => {
fs.appendFileSync(
Expand Down Expand Up @@ -56,7 +55,7 @@ process.on('unhandledRejection', (err, origin) => {

const translator = require('./lib/translate.js')
const myTranslator = new translator.translator(translator.getSystemLocale())
myTranslator.mcVersion = mcDetail.version
myTranslator.mcVersion = app.getVersion()

if ( process.platform === 'win32' && app.isPackaged && gotTheLock && !isPortable ) {
autoUpdater.on('update-checking-for-update', () => { log.log.info('Checking for update', 'auto-update') })
Expand Down Expand Up @@ -227,7 +226,7 @@ if ( semverGt('1.0.2', mcStore.get('cache_version'))) {
log.log.info('Mod Cache Version Good')
}

mcStore.set('cache_version', mcDetail.version)
mcStore.set('cache_version', app.getVersion())

/** END: Upgrade Cache Version Here */

Expand Down Expand Up @@ -317,7 +316,7 @@ function createMainWindow () {

if ( !devDebug ) {
windows.splash = createSubWindow({ center : true, fixed : true, move : false, frame : false, width : 600, height : 300 })
windows.splash.loadURL(`file://${path.join(pathRender, 'splash.html')}?version=${mcDetail.version}`)
windows.splash.loadURL(`file://${path.join(pathRender, 'splash.html')}?version=${app.getVersion()}`)

windows.splash.on('closed', () => { windows.splash = null })

Expand Down Expand Up @@ -755,7 +754,7 @@ ipcMain.on('toMain_langList_send', (event) => {
ipcMain.on('toMain_getText_send', (event, l10nSet) => {
l10nSet.forEach((l10nEntry) => {
if ( l10nEntry === 'app_version' ) {
event.sender.send('fromMain_getText_return', [l10nEntry, mcDetail.version])
event.sender.send('fromMain_getText_return', [l10nEntry, app.getVersion()])
} else if ( l10nEntry === 'clean_cache_size' ) {
const cleanString = myTranslator.syncStringLookup(l10nEntry)
let cacheSize = 0
Expand Down Expand Up @@ -1473,8 +1472,8 @@ function processModFolders_post(newFolder = false) {
refreshClientModList()
loadingWindow_hide()

if ( mcStore.get('rel_notes') !== mcDetail.version ) {
mcStore.set('rel_notes', mcDetail.version )
if ( mcStore.get('rel_notes') !== app.getVersion() ) {
mcStore.set('rel_notes', app.getVersion() )
log.log.info('New version detected, show changelog')
createChangeLogWindow()
}
Expand Down Expand Up @@ -1566,7 +1565,7 @@ app.whenReady().then(() => {

app.setAboutPanelOptions({
applicationName : 'FS Mod Assist',
applicationVersion : mcDetail.version,
applicationVersion : app.getVersion(),
copyright : '(c) 2022-present FSG Modding',
credits : 'J.T.Sage <[email protected]>',
website : 'https://github.com/FSGModding/FSG_Mod_Assistant',
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "fsg-mod-assistant",
"version": "1.1.1",
"version": "1.2.0",
"description": "FSG Farm Sim Mod Assistant",
"main": "modAssist_main.js",
"homepage": "https://github.com/FSGModding/FSG_Mod_Assistant#readme",
Expand Down
4 changes: 2 additions & 2 deletions renderer/main.html
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ <h2 class="ps-2 mastHead"><l10n name="app_name"></l10n> <l10n class="ver" name="
</div>
<div class="col-3">
<div class="row float-end">
<div class="col-auto">
<div class="col-1">
<label for="language_select" class="pt-1 col-form-label"><svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-globe2" viewBox="0 0 16 16">
<path d="M0 8a8 8 0 1 1 16 0A8 8 0 0 1 0 8zm7.5-6.923c-.67.204-1.335.82-1.887 1.855-.143.268-.276.56-.395.872.705.157 1.472.257 2.282.287V1.077zM4.249 3.539c.142-.384.304-.744.481-1.078a6.7 6.7 0 0 1 .597-.933A7.01 7.01 0 0 0 3.051 3.05c.362.184.763.349 1.198.49zM3.509 7.5c.036-1.07.188-2.087.436-3.008a9.124 9.124 0 0 1-1.565-.667A6.964 6.964 0 0 0 1.018 7.5h2.49zm1.4-2.741a12.344 12.344 0 0 0-.4 2.741H7.5V5.091c-.91-.03-1.783-.145-2.591-.332zM8.5 5.09V7.5h2.99a12.342 12.342 0 0 0-.399-2.741c-.808.187-1.681.301-2.591.332zM4.51 8.5c.035.987.176 1.914.399 2.741A13.612 13.612 0 0 1 7.5 10.91V8.5H4.51zm3.99 0v2.409c.91.03 1.783.145 2.591.332.223-.827.364-1.754.4-2.741H8.5zm-3.282 3.696c.12.312.252.604.395.872.552 1.035 1.218 1.65 1.887 1.855V11.91c-.81.03-1.577.13-2.282.287zm.11 2.276a6.696 6.696 0 0 1-.598-.933 8.853 8.853 0 0 1-.481-1.079 8.38 8.38 0 0 0-1.198.49 7.01 7.01 0 0 0 2.276 1.522zm-1.383-2.964A13.36 13.36 0 0 1 3.508 8.5h-2.49a6.963 6.963 0 0 0 1.362 3.675c.47-.258.995-.482 1.565-.667zm6.728 2.964a7.009 7.009 0 0 0 2.275-1.521 8.376 8.376 0 0 0-1.197-.49 8.853 8.853 0 0 1-.481 1.078 6.688 6.688 0 0 1-.597.933zM8.5 11.909v3.014c.67-.204 1.335-.82 1.887-1.855.143-.268.276-.56.395-.872A12.63 12.63 0 0 0 8.5 11.91zm3.555-.401c.57.185 1.095.409 1.565.667A6.963 6.963 0 0 0 14.982 8.5h-2.49a13.36 13.36 0 0 1-.437 3.008zM14.982 7.5a6.963 6.963 0 0 0-1.362-3.675c-.47.258-.995.482-1.565.667.248.92.4 1.938.437 3.008h2.49zM11.27 2.461c.177.334.339.694.482 1.078a8.368 8.368 0 0 0 1.196-.49 7.01 7.01 0 0 0-2.275-1.52c.218.283.418.597.597.932zm-.488 1.343a7.765 7.765 0 0 0-.395-.872C9.835 1.897 9.17 1.282 8.5 1.077V4.09c.81-.03 1.577-.13 2.282-.287z"/>
</svg></label>
Expand All @@ -109,7 +109,7 @@ <h2 class="ps-2 mastHead"><l10n name="app_name"></l10n> <l10n class="ver" name="
</div>
<div class="col-3 text-end">
<button onclick="window.mods.startFarmSim()" class="btn btn-info w-75" id="open_prefs"><l10n name="launch_fs22"></l10n></button>
<button onclick="window.mods.openPreferences()" class="btn btn-outline-light" id="open_prefs"><l10n name="preferences_button"></l10n></button>
<button onclick="window.mods.openPreferences()" class="btn btn-outline-light ms-2" id="open_prefs"><l10n name="preferences_button"></l10n></button>

</div>
</div>
Expand Down
2 changes: 1 addition & 1 deletion renderer/renderJS/assist_ui.js
Original file line number Diff line number Diff line change
Expand Up @@ -137,7 +137,7 @@ window.mods.receive('fromMain_modList', (currLocale, modList, extraL10n, current

modTable.push(makeModCollection(
collection,
`${modList[collection].name} (${modList[collection].mods.length}) <small>[${fsgUtil.bytesToHR(sizeOfFolder, currLocale)}]</small>`,
`${modList[collection].name} <small>[${modList[collection].mods.length}] [${fsgUtil.bytesToHR(sizeOfFolder, currLocale)}]</small>`,
modRows,
collWebsite,
collDL
Expand Down
2 changes: 1 addition & 1 deletion renderer/renderJS/confirm_multi_ui.js
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ const makeRow = (row) => `<tr><td>${row[2]}</td><td>${row[3]}</td></tr>`

const makeCheck = (id, name, dir) => `<div class="form-check form-switch mb-2">
<input class="form-check-input" type="checkbox" id="${id}">
<label class="ms-2 form-check-label" for="${id}">${name} <small>${dir}</small></label>
<label class="ms-2 form-check-label row" for="${id}"><div class="col-3">${name}</div><div class="col-9"><small>${dir}</small></div></label>
</div>`


Expand Down
Binary file modified screen_shots/001-main_program.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified screen_shots/001-main_program.psd
Binary file not shown.
Binary file modified screen_shots/002-main_program_collect.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified screen_shots/003-collect_detail.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified screen_shots/005-collect_search.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified screen_shots/008-savegame.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified screen_shots/009-version_overview.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified screen_shots/010-version_resolve.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified screen_shots/011-folders.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified screen_shots/013-detail_top.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified screen_shots/015-notes.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added screen_shots/016-copyfavs.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 626b53f

Please sign in to comment.