Merge branch 'master' into release

CROSSOVER_ALERT_DISABLED

@@ -0,0 +1,2 @@
+There was a bug in v2.7.4. Please manually update CrossOver
+[Download the newest version here](https://github.com/lacymorrow/crossover/releases/latest)

electron-builder-appx.yaml

@@ -13,3 +13,4 @@ appx:
   publisher: CN=C53C0091-1EEB-40B4-8537-082E06A4D328
   publisherDisplayName: Fly5
   showNameOnTiles: true
+  verifyUpdateCodeSignature: false

package.json

@@ -1,5 +1,5 @@
 {
-    "name": "crossoverapp",
+    "name": "crossover",
     "productName": "CrossOver",
     "appId": "com.lacymorrow.crossover",
     "version": "3.0.0",
@@ -53,7 +53,10 @@
         "build:deb": "electron-builder --linux deb",
         "build:snap": "electron-builder --linux snap",
         "build:release": "rm -rf dist && yarn build:mac && yarn build:wl && yarn build:snap && yarn sh:copyexe",
-        "build:release:windows": "yarn build:windows && yarn sh:copyexe"
+        "build:release:snap": "electron-builder --linux snap && yarn snap:release",
+        "build:release:windows": "yarn build:windows && yarn sh:copyexe",
+        "snap:login:export": "snapcraft export-login --snaps crossover --channels edge,stable -",
+        "snap:release": "snapcraft upload --release=stable dist/*.snap"
     },
     "dependencies": {
         "electron-debug": "^3.0.1",
@@ -64,8 +67,7 @@
         "electron-updater": "4.3.1",
         "electron-util": "^0.17.0",
         "electron-winstore-auto-launch": "^2.0.6",
-        "iohook": "^0.9.3",
-        "nodemon": "^2.0.15"
+        "iohook": "^0.9.3"
     },
     "devDependencies": {
         "@babel/core": "^7.17.8",
@@ -82,6 +84,7 @@
         "husky": "^7.0.1",
         "jimp": "^0.16.1",
         "madge": "^5.0.1",
+        "nodemon": "^2.0.15",
         "np": "^7.2.0",
         "playwright": "^1.20.1",
         "sass": "^1.26.5"

readme.md

@@ -80,7 +80,7 @@ Or download from the Snap Store
 - <kbd>Control</kbd>-<kbd>Alt</kbd>-<kbd>Shift</kbd>-<kbd>X</kbd> to lock in place
 - <kbd>Control</kbd>-<kbd>Alt</kbd>-<kbd>Shift</kbd>-<kbd>R</kbd> to reset app settings
 
-[See usage...](#usage)
+[See usage…](#usage)
 
 <p align="center">
 	<br />
@@ -100,8 +100,11 @@ Or download from the Snap Store
 - Cross-platform: Windows, MacOS, and Linux support
 - Support for multiple monitors
 - Choose between center **Dot** or **Crosshair**
+- Create duplicate crosshairs to mark more than one spot
 - Customize crosshair size, color, and opacity
-- Persistant settings remembers your choices automatically
+- Customize SVG properties
+- Light/Dark mode and custom app colors
+- Persistent settings remember your choices automatically
 - Automatically updates in the background to keep your features fresh _(Mac and Windows only)_
 
 <sup>* </sup> Escape from Tarkov will not work with CrossOver ([#47](https://github.com/lacymorrow/crossover/issues/47#issuecomment-987762466))
@@ -162,7 +165,7 @@ _The AppImage needs to be [made executable](http://discourse.appimage.org/t/how-
 
 # Usage
 
-> ❌ marks the spot...
+> ❌ marks the spot…
 
 **Position:** Click and drag the crosshair to anywhere on any screen. Double-click the bullseye to center the app.
 

src/config/config.js

@@ -7,13 +7,14 @@ const APP_WIDTH = 208
 // 16/10: 220x352 16/9: 224x356
 
 const DEFAULT_THEME = 'dark'
+const ALERT_URL = 'https://raw.githubusercontent.com/lacymorrow/crossover/master/CROSSOVER_ALERT'
 const HOMEPAGE_URL = 'https://lacymorrow.github.io/crossover'
 const RELEASES_URL = 'https://github.com/lacymorrow/crossover/releases/latest'
 const APP_ASPECT_RATIO = 16 / 10
 const APP_HEIGHT_MEDIUM = 225
 const APP_WIDTH_MEDIUM = 360
 const APP_BACKGROUND_OPACITY = 0.6
-const MAX_SHADOW_WINDOWS = 20
+const MAX_SHADOW_WINDOWS = 14
 const SETTINGS_WINDOW_DEVTOOLS = true
 const SHADOW_WINDOW_OFFSET = 40
 
@@ -35,6 +36,7 @@ const config = {
 	APP_WIDTH_MEDIUM,
 	DEFAULT_THEME,
 	FILE_FILTERS,
+	ALERT_URL,
 	HOMEPAGE_URL,
 	RELEASES_URL,
 	MAX_SHADOW_WINDOWS,

src/main.js

@@ -158,6 +158,9 @@ const ready = async () => {
 	/* Press Play >>> */
 	init()
 
+	// Alert from developer
+	// alert.init()
+
 	console.timeEnd( 'init' )
 
 }
@@ -168,7 +171,7 @@ module.exports = async () => {
 
 	await app.whenReady()
 
-	// Added 400 ms to fix the black background issue while using transparent window. More detais at https://github.com/electron/electron/issues/15947
+	// Added 400 ms to fix the black background issue while using transparent window. More details at https://github.com/electron/electron/issues/15947
 	setTimeout( ready, 400 )
 
 }

src/main/alert.js

@@ -0,0 +1,43 @@
+/*
+	Developer Alerts
+
+	If a file named CROSSOVER_ALERT is found in the root of the master branch, users will see the alert pop up in a dialog.
+
+	Todo: Markdown
+*/
+const got = require( 'got' )
+const { ALERT_URL } = require( '../config/config' )
+const { checkboxTrue } = require( '../config/utils' )
+const dialog = require( './dialog' )
+const log = require( './log' )
+const preferences = require( './preferences' ).init()
+
+const init = async () => {
+
+	if ( !checkboxTrue( preferences.value( 'app.alerts' ), 'alerts' ) ) {
+
+		return
+
+	}
+
+	// We phone github here
+	const message = await got.get( ALERT_URL ).catch( error => {
+
+		log.info( 'No alerts found.', error )
+
+	} )
+
+	if ( message.body ) {
+
+		// notification( { title: 'CrossOver: Developer Update', body: message.body } )
+
+		dialog.openAlertDialog( message.body )
+
+	}
+
+}
+
+const alert = {
+	init,
+}
+module.exports = alert

src/main/auto-update.js

@@ -11,58 +11,74 @@ const { RELEASES_URL } = require( '../config/config' )
 const notification = require( './notification' )
 const dock = require( './dock' )
 
+const FOUR_HOURS = 1000 * 60 * 60 * 4
+
 const install = () => autoUpdater.quitAndInstall()
 
-const update = () => {
+const onDownloadProgress = progressObject => {
 
-	// Comment this before publishing your first version.
-	// It's commented out as it throws an error if there are no published versions.
-	if ( checkboxTrue( preferences.value( 'app.updates' ), 'updates' ) ) {
+	let message = 'Download speed: ' + progressObject.bytesPerSecond
+	message = message + ' - Downloaded ' + progressObject.percent + '%'
+	message = message + ' (' + progressObject.transferred + '/' + progressObject.total + ')'
+	log.info( message )
 
-		log.info( 'Setting: Automatic Updates' )
+	// Dock progress bar
+	windows.setProgress( progressObject.percent / 100 )
 
-		autoUpdater.logger = log
-		autoUpdater.on( 'update-available', () => {
-
-			sound.play( 'UPDATE' )
-			windows.win.webContents.send( 'set_info_icon', 'info' )
+}
 
-			if ( is.linux ) {
+const onUpdateAvailable = () => {
 
-				dialog.openUpdateDialog( () => {
+	sound.play( 'UPDATE' )
+	windows.win.webContents.send( 'set_info_icon', 'info' )
 
-					// AutoUpdater.downloadUpdate()
-					shell.openExternal( RELEASES_URL )
+	if ( is.linux ) {
 
-				} )
+		dialog.openUpdateDialog( () => {
 
-			}
+			// AutoUpdater.downloadUpdate()
+			shell.openExternal( RELEASES_URL )
 
 		} )
 
-		if ( !is.linux ) {
+	}
+
+}
+
+const onUpdateDownloaded = () => {
+
+	windows.setProgress( -1 )
+	dock.setBadge( '!' )
+	notification( { title: 'CrossOver has been Updated', body: 'Relaunch to take effect' } )
+	// sound.play( 'DONE' ) // uncomment if we make notification silent
+
+}
+
+const update = () => {
+
+	// Comment this before publishing your first version.
+	// It's commented out as it throws an error if there are no published versions.
+
+	// We trycatch here because appx throws errors
+	try {
 
-			autoUpdater.on( 'download-progress', progressObject => {
+		if ( checkboxTrue( preferences.value( 'app.updates' ), 'updates' ) ) {
 
-				let message = 'Download speed: ' + progressObject.bytesPerSecond
-				message = message + ' - Downloaded ' + progressObject.percent + '%'
-				message = message + ' (' + progressObject.transferred + '/' + progressObject.total + ')'
-				log.info( message )
+			log.info( 'Setting: Automatic Updates' )
 
-				// Dock progress bar
-				windows.setProgress( progressObject.percent / 100 )
+			autoUpdater.logger = log
+			autoUpdater.on( 'update-available', autoUpdate.onUpdateAvailable )
 
-			} )
+			if ( is.linux ) {
+
+				return
+
+			}
 
-			autoUpdater.on( 'update-downloaded', () => {
+			autoUpdater.on( 'download-progress', autoUpdate.onDownloadProgress )
 
-				windows.setProgress( -1 )
-				dock.setBadge( '!' )
-				notification( { title: 'CrossOver has been Updated', body: 'Relaunch to take effect' } )
-				// PlaySound( 'DONE' )
+			autoUpdater.on( 'update-downloaded', autoUpdate.onUpdateDownloaded )
 
-			} )
-			const FOUR_HOURS = 1000 * 60 * 60 * 4
 			setInterval( () => {
 
 				autoUpdater.checkForUpdates()
@@ -73,9 +89,19 @@ const update = () => {
 
 		}
 
+	} catch ( error ) {
+
+		log.error( error )
+
 	}
 
 }
 
-const autoUpdate = { install, update }
+const autoUpdate = {
+	install,
+	onDownloadProgress,
+	onUpdateAvailable,
+	onUpdateDownloaded,
+	update,
+}
 module.exports = autoUpdate

src/main/dialog.js

@@ -1,12 +1,25 @@
 /* eslint no-useless-concat: 0 */
 const path = require( 'path' )
-const { app, dialog: electronDialog } = require( 'electron' )
+const { app, dialog: electronDialog, shell } = require( 'electron' )
 const log = require( 'electron-log' )
 const { debugInfo, is, showAboutWindow } = require( 'electron-util' )
 
-const { __static, FILE_FILTERS } = require( '../config/config.js' )
+const { __static, FILE_FILTERS, HOMEPAGE_URL } = require( '../config/config.js' )
 const set = require( './set.js' )
 const notification = require( './notification.js' )
+const preferences = require( './preferences.js' ).init()
+
+const validButtonIndex = result => {
+
+	if ( typeof result === 'object' && typeof result.response === 'number' ) {
+
+		return result.response
+
+	}
+
+	return result
+
+}
 
 const openAboutWindow = () => {
 
@@ -18,6 +31,35 @@ const openAboutWindow = () => {
 
 }
 
+const openAlertDialog = async message => {
+
+	await electronDialog.showMessageBox( {
+		type: 'info',
+		title: 'CrossOver: Developer Update',
+		message,
+		buttons: [
+			'Turn off alerts', 'Open in browser…', 'Dismiss',
+		],
+	} ).then( result => {
+
+		const buttonIndex = validButtonIndex( result )
+
+		if ( buttonIndex === 0 ) {
+
+			return preferences.value( 'app.alerts', [] )
+
+		}
+
+		if ( buttonIndex === 1 ) {
+
+			return shell.openExternal( HOMEPAGE_URL )
+
+		}
+
+	} )
+
+}
+
 const openCustomImageDialog = async () => {
 
 	await electronDialog.showOpenDialog( {
@@ -54,7 +96,9 @@ const openReportCrashDialog = async crash => {
 	} )
 		.then( result => {
 
-			if ( result.response === 1 ) {
+			const buttonIndex = validButtonIndex( result )
+
+			if ( buttonIndex === 1 ) {
 
 				crash.submitIssue( 'https://github.com/lacymorrow/crossover/issues/new', {
 					title: `Error report for ${crash.versions.app}`,
@@ -65,7 +109,7 @@ const openReportCrashDialog = async crash => {
 
 			}
 
-			if ( result.response === 2 ) {
+			if ( buttonIndex === 2 ) {
 
 				app.quit()
 
@@ -82,8 +126,9 @@ const openUpdateDialog = async action => {
 		title: 'CrossOver Update Available',
 		message: '',
 		buttons: [ 'Update', 'Ignore' ],
-	} ).then( buttonIndex => {
+	} ).then( result => {
 
+		const buttonIndex = validButtonIndex( result )
 		if ( buttonIndex === 0 && typeof action === 'function' ) {
 
 			action()
@@ -96,6 +141,7 @@ const openUpdateDialog = async action => {
 
 const dialog = {
 	openAboutWindow,
+	openAlertDialog,
 	openCustomImageDialog,
 	openReportCrashDialog,
 	openUpdateDialog,