Release for 0.4.0.

Updated the readme for installation and usage of 0.4.0.
The default startup type at installation is now Automatic and the option has been changed to 'ManualStartup'.
Fixed the descriptions for the parameters for the install script.

Author: RobotsOnDrugs

README.md

@@ -1,8 +1,29 @@
 # Moo.FuckScreenConnect-rs
 
 Moo.FuckScreenConnect is a tool to make the privacy screen for ScreenConnect Client (and Remote Utilities) semi-transparent, allowing you to see what a scammer is doing while they think their actions are secret.\
-Support for remote desktop software (e.g., AnyDesk) that does not use a standard window for its privacy screen is outside the scope of this project, but may be supported in a separate project in the future.
+Support for remote desktop software (e.g., AnyDesk) that does not use a standard window for its privacy screen is outside the scope of this project.
 
 This is a port of the original formerly private program written in C# to Rust, made simpler and easier to understand and maintain. Now with support for Remote Utilities!
 
-Feature requests are welcome, but please file an issue here on GitHub rather than making a direct request elsewhere.
+Feature requests are welcome, but please file an issue here on GitHub rather than making a direct request elsewhere.
+
+## Installation
+The easiest way to install or uninstall FSC is to download the [latest release](https://github.com/RobotsOnDrugs/Moo.FuckScreenConnect-rs/releases) and use the included PowerShell script `install.ps1`. This script must be run as an administrator from the command line. You may need to set PowerShell's execution policy to allow the script to run.
+```powershell
+Set-ExecutionPolicy -ExecutionPolicy Bypass
+```
+or, for only the script:
+```powershell
+Unblock-File '.\install.ps1'
+```
+If updating from version 0.3.x or earlier, it is highly advised to uninstall using the installation script from that release before installing version 0.4.
+
+### install.ps1 Optional Parameters
+ - `ApplicationPath [custom\path\here]` - Specifies an alternate installation directory. Note: when uninstalling, this parameter must be set to the directory specified during installation.
+ - `Type [Install|Uninstall]` - Specifies whether to install or uninstall FSC. By default, it will install.
+ - `ServiceName [Name]` - Specifies a custom name for the service which will appear in places where services are displayed such as Task Manager or the Services application. When uninstalling, this parameter must be set to the name specified during installation.
+ - `ManualStartup` - Specifies whether to start the service automatically at boot or only when started manually. If set, it will not start automatically at boot and must be started manually.
+ - `ShowDebugMessages` - Shows extra information that is intended for aiding development. The messages that are displayed are subject to change.
+
+## Usage
+FSC runs as a Windows service. Once installed, it will run in the background and requires no additional interaction if set to automatic startup. It can be stopped and started in the same manner as any other Windows service.

fsc_common/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "fsc_common"
-version = "0.4.0-beta3"
+version = "0.4.0"
 edition = "2024"
 
 [dependencies]

fsc_core/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "fsc_core"
-version = "0.4.0-beta3"
+version = "0.4.0"
 edition = "2024"
 
 [dependencies]

fsc_core/build.rs

@@ -12,7 +12,7 @@ fn main()
 	embed_manifest(manifest_builder).expect("Couldn't embed manifest.");
 
 	let mut res = WindowsResource::new();
-	let file_description = std::env::var("BINARY_FILE_DESCRIPTION");
+	let file_description = env::var("BINARY_FILE_DESCRIPTION");
 	let git_version = env::var("GIT_VERSION");
 	if let Ok(ref desc) = file_description
 	{

fsc_service/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "fsc_service"
-version = "0.4.0-beta3"
+version = "0.4.0"
 edition = "2024"
 
 [dependencies]

install.ps1

@@ -4,24 +4,24 @@
 	.DESCRIPTION
 	Installs FuckScreenConnect either from the current directory or a specified path.
 	If there is an error, regardless of any options specified, the script will immediately halt and any issues must then be resolved manually.
-	.PARAMETER ApplicationPath
-		Optional; the current directory is used by default. Specifies the directory containing fsc_service.exe and fsc_core.exe.
+	.PARAMETER ApplicationPath [Path to custom directory]
+		Optional; defaults to the Program Files directory. If set, it will install to the custom directory specified.
 	.PARAMETER Type [Install | Uninstall]
 		Optional; defaults to Install. Installs or uninstalls the service.
-	.PARAMETER ServiceName
-		Optional; "FSC Service" by default. Specifies the name of the FSC service that will appear in e.g., the Services application or Task Manager.
-	.PARAMETER AutomaticStartup
-		Optional; false by default. If set, the service will be set to automatically start at boot. If unset, the service will not and can be started manually.
+	.PARAMETER ServiceName [Name]
+		Optional; defaults to "FSC Service". Specifies the name of the FSC service that will appear in e.g., the Services application or Task Manager.
+	.PARAMETER ManualStartup
+		Optional. If set, the service must be started or stopped manually. Otherwise, the service will start automatically at boot.
 	.PARAMETER ShowDebugMessages
-		Optional; unset by default. If set, debug messages are shown. Primarily meant for troubleshooting and developer use, and the messages shown are subject to change.
+		Optional. If set, debug messages are shown. Primarily meant for troubleshooting and developer use, and the messages shown are subject to change.
 #>
 
 param
 (
 	[string]$ApplicationPath = "$env:PROGRAMFILES\FSC Service",
 	[string][ValidateSet('Install','Uninstall')]$Type = 'Install',
 	[string]$ServiceName = 'FSC Service',
-	[Switch]$AutomaticStartup,
+	[Switch]$ManualStartup,
 	[Switch]$ShowDebugMessages
 )
 
@@ -39,13 +39,13 @@ Write-Log -Level INFO -Message 'Starting.'
 
 $is_absolute = [System.IO.Path]::IsPathRooted($ApplicationPath);
 if (!$is_absolute) { $ApplicationPath = "$PWD", "$ApplicationPath" -join '\' }
-if (-not $AutomaticStartup) { $AutomaticStartup = $false }
+if ($ManualStartup) { $ManualStartup = $true }
 switch ($Type)
 {
 	'Install'
 	{
 		Write-Log -Level INFO -Message 'Installing FSC.'
-		Set-Installation "$ServiceName" $AutomaticStartup "$ApplicationPath"
+		Set-Installation "$ServiceName" $ManualStartup "$ApplicationPath"
 		break
 	}
 	'Uninstall'

install_modules/fsc_functions.ps1

@@ -19,23 +19,22 @@ function Get-InstallationStatus
 
 function Set-Installation
 {
-	param([string]$service_name, [bool]$is_automatic, [string]$path)
+	param([string]$service_name, [bool]$is_manual, [string]$path)
 	$clean = ((Get-InstallationStatus "$service_name") -eq [ExistingInstallationStatus]::None)
 	if (!$clean) { Remove-Installation "$service_name" "$path" }
 	Write-Log -Level INFO -Message "Installing $service_name."
-	if ($is_automatic) { $start_type = 'AutomaticDelayedStart' }
-	else { $start_type = 'Manual' }
+	if ($is_manual) { $start_type = 'Manual' }
+	else { $start_type = 'Automatic' }
 	New-Item -ItemType Directory -Path "$path" -Force | Out-Null
 	Copy-Item '.\fsc_service.exe' "$path"
 	Copy-Item '.\fsc_core.exe' "$path"
 	$service_path = "$path", '\fsc_service.exe' -join ''
 	New-Service -Name "$service_name" -BinaryPathName "`"$service_path`" `"$service_name`"" -DisplayName "$service_name" -StartupType $start_type | Out-Null
 	$status = (Get-InstallationStatus $service_name)
 	if ($status -ne [ExistingInstallationStatus]::Normal) { Stop-ScriptWithError -ErrorMessage "Could not create service $service_name." }
-	Start-Service -Name "$service_name" | Out-Null
+	if (-not $is_manual) { Start-Service -Name "$service_name" | Out-Null }
 	$start_status = (Get-Service -Name "$service_name").Status
 	Write-Log -Level DEBUG "Start status: $start_status"
-	if (!$start_status.Equals([System.ServiceProcess.ServiceControllerStatus]::Running)) { Stop-ScriptWithError -ErrorMessage "Could not start service $service_name." }
 
 	return Get-InstallationStatus $service_name
 }