Skip to content

Commit

Permalink
Rebranding
Browse files Browse the repository at this point in the history
  • Loading branch information
LeonarddeR committed Jul 25, 2023
1 parent 1d5da26 commit 4ae14a4
Show file tree
Hide file tree
Showing 12 changed files with 26 additions and 26 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -137,8 +137,8 @@ def __init__(self):
if isRunningOnSecureDesktop():
return
config.post_configProfileSwitch.register(self._handlePostConfigProfileSwitch)
gui.settingsDialogs.NVDASettingsDialog.categoryClasses.append(settingsPanel.NvdaRDSettingsPanel)
settingsPanel.NvdaRDSettingsPanel.post_onSave.register(self._handlePostConfigProfileSwitch)
gui.settingsDialogs.NVDASettingsDialog.categoryClasses.append(settingsPanel.RemoteDesktopSettingsPanel)
settingsPanel.RemoteDesktopSettingsPanel.post_onSave.register(self._handlePostConfigProfileSwitch)

def _initializeExistingPipes(self):
for match in namedPipe.getRdPipeNamedPipes():
Expand Down Expand Up @@ -208,8 +208,8 @@ def _unregisterRdPipeFromRegistry(cls):
def terminate(self):
try:
if not isRunningOnSecureDesktop():
settingsPanel.NvdaRDSettingsPanel.post_onSave.unregister(self._handlePostConfigProfileSwitch)
gui.settingsDialogs.NVDASettingsDialog.categoryClasses.remove(settingsPanel.NvdaRDSettingsPanel)
settingsPanel.RemoteDesktopSettingsPanel.post_onSave.unregister(self._handlePostConfigProfileSwitch)
gui.settingsDialogs.NVDASettingsDialog.categoryClasses.remove(settingsPanel.RemoteDesktopSettingsPanel)
config.post_configProfileSwitch.unregister(self._handlePostConfigProfileSwitch)
configuredOperatingMode = configuration.getOperatingMode()
if (
Expand Down
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
addonHandler.initTranslation()


class NvdaRDSettingsPanel(SettingsPanel):
class RemoteDesktopSettingsPanel(SettingsPanel):
# Translators: The label for the NVDA Remote Desktop settings panel.
title = _("Remote Desktop")
post_onSave = Action()
Expand Down
File renamed without changes.
16 changes: 8 additions & 8 deletions buildVars.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,24 +16,24 @@ def _(arg):
# Add-on information variables
addon_info = {
# add-on Name/identifier, internal for NVDA
"addon_name": "nvdaRd",
"addon_name": "rdAccess",
# Add-on summary, usually the user visible name of the addon.
# Translators: Summary for this add-on
# to be shown on installation and add-on information found in Add-ons Manager.
"addon_summary": _("NVDA Remote Desktop Support"),
"addon_summary": _("Remote Desktop Accessibility"),
# Add-on description
# Translators: Long description to be shown for this add-on on add-on information from add-ons manager
"addon_description": _(
"Allows using speech and braille with Microsoft Remote Desktop, Citrix Workspace and VMware Horizon"
),
# version
"addon_version": "0.2.0",
"addon_version": "0.9.0",
# Author(s)
"addon_author": "Leonard de Ruijter <[email protected]>",
# URL for the add-on documentation support
"addon_url": "https://github.com/leonardder/nvdaRd",
"addon_url": "https://github.com/leonardder/rdAccess",
# URL for the add-on repository where the source code can be found
"addon_sourceURL": "https://github.com/leonardder/nvdaRd",
"addon_sourceURL": "https://github.com/leonardder/rdAccess",
# Documentation file name
"addon_docFileName": "readme.html",
# Minimum NVDA version supported (e.g. "2018.3.0", minor version is optional)
Expand All @@ -45,7 +45,7 @@ def _(arg):
# Do not change unless you know what you are doing!
"addon_updateChannel": None,
# Add-on license such as GPL 2
"addon_license": None,
"addon_license": "GPL 2",
# URL for the license document the ad-on is licensed under
"addon_licenseURL": None,
}
Expand All @@ -60,8 +60,8 @@ def _(arg):
# https://scons.org/doc/production/HTML/scons-user/apd.html
pythonSources = [
"addon/brailleDisplayDrivers/*.py",
"addon/globalPlugins/nvdaRd/*.py",
"addon/globalPlugins/nvdaRd/handlers/*.py",
"addon/globalPlugins/rdAccess/*.py",
"addon/globalPlugins/rdAccess/handlers/*.py",
"addon/lib/*.py",
"addon/lib/driver/*.py",
"addon/lib/protocol/*.py",
Expand Down
26 changes: 13 additions & 13 deletions readme.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# NVDA Remote Desktop
# RDAccess: Remote Desktop Accessibility

* Authors: [Leonard de Ruijter][1]
* NVDA compatibility: 2023.2 and later

This add-on adds support to access remote desktop sessions to NVDA using Microsoft Remote Desktop, Citrix or VMware Horizon.
The RDAccess add-on (Remote Desktop Accessibility) adds support to access remote desktop sessions to NVDA using Microsoft Remote Desktop, Citrix or VMware Horizon.
When installed in NVDA on both the client and the server, speech and braille generated on the server will be spoken and brailled by the client machine.
This enables a user experience where managing a remote system feels just as performant as operating the local system.

Expand All @@ -22,13 +22,13 @@ This enables a user experience where managing a remote system feels just as perf

## Getting started

1. Install this add-on in both a client and server copy of NVDA.
1. Install RDAccess in both a client and server copy of NVDA.
1. The remote system should automatically start speaking using the local speech synthesizer. If not, in the NVDA instance on the server, select the remote speech synthesizer from NVDA"s synthesizer selection dialog.
1. To use braille, enable automatic braille display detection using the braille display selection dialog.

## Configuration

After installation, the NVDA Remote Desktop add-on can be configured using NVDA's settings dialog, which can be accessed from the NVDA Menu by choosing Preferences > Settings...
After installation, the rdAccess add-on can be configured using NVDA's settings dialog, which can be accessed from the NVDA Menu by choosing Preferences > Settings...
After that, choose the Remote Desktop category.

This dialog contains the following settings:
Expand Down Expand Up @@ -66,7 +66,7 @@ Otherwise, you are advised to disable it, as it implies some performance degrada
This client option is only available on installed copies of NVDA.
When enabled, it ensures that the client portion of NVDA is loaded in your remote desktop client, even when NVDA is not running.

To use the client portion of NVDA Remote Desktop, several changes have to be maede in the Windows Registry.
To use the client portion of RDAccess, several changes have to be maede in the Windows Registry.
The add-on ensures that these changes are made under the profile of the current user.
These changes don't require administrative privileges.
Therefore, NVDA can automatically apply the necessary changes when loaded, and undo these changes when exiting NVDA.
Expand All @@ -76,34 +76,34 @@ However, if you are running an installed copy and you are the only user of the s

### Enable Microsoft Remote Desktop support

This option is enabled by default and ensures that the client portion of NVDA Remote Desktop is loaded in the Microsoft Remote Desktop client (mstsc) when starting NVDA.
This option is enabled by default and ensures that the client portion of RDAccess is loaded in the Microsoft Remote Desktop client (mstsc) when starting NVDA.
Unless persistent client support is enabled by enabling the previous option, these changes will be automatically undone when exiting NVDA.

### Enable Citrix Workspace support

This option is enabled by default and ensures that the client portion of NVDA Remote Desktop is loaded in the Citrix Workspace app when starting NVDA.
This option is enabled by default and ensures that the client portion of RDAccess is loaded in the Citrix Workspace app when starting NVDA.
Unless persistent client support is enabled by enabling the previous option, these changes will be automatically undone when exiting NVDA.

This option is only available in the following cases:

* Citrix Workspace is installed. Note that the Windows Store version of the app is not supported due to limitations in that app itself
* It is possible to register NVDA Remote Desktop under the current user context. After installing the app, you have to start a remote session once to make this possible
* It is possible to register RDAccess under the current user context. After installing the app, you have to start a remote session once to make this possible

## Citrix specific instructions

There are some important points of attention when using NVDA Remote Desktop with the Citrix Workspace app.
There are some important points of attention when using RDAccess with the Citrix Workspace app.

### Client side requirements

1. The Windows Store variant of the app is *not* supported.

2. After installing Citrix Workspace, you have to start a remote session once to allow NVDA Remote Desktop registering itself. The reason behind this is that the application copies the system configuration to the user configuration when it establishes a session for the first time. After that, NVDA Remote Desktop can register itself under the current user context.
2. After installing Citrix Workspace, you have to start a remote session once to allow RDAccess registering itself. The reason behind this is that the application copies the system configuration to the user configuration when it establishes a session for the first time. After that, NVDA Remote Desktop can register itself under the current user context.

### Server side requirement

In Citrix Virtual Apps and Desktops 2109, Citrix enabled the so called virtual channel allow list. This means that third party virtual channels, including the channel required bij NVDA Remote Desktop, is not allowed by default. For more information, [see this Citrix blog post](https://www.citrix.com/blogs/2021/10/14/virtual-channel-allow-list-now-enabled-by-default/)
In Citrix Virtual Apps and Desktops 2109, Citrix enabled the so called virtual channel allow list. This means that third party virtual channels, including the channel required by RDAccess, is not allowed by default. For more information, [see this Citrix blog post](https://www.citrix.com/blogs/2021/10/14/virtual-channel-allow-list-now-enabled-by-default/)

Explicitly allowing the RdPipe channel required by NVDA Remote Desktop is not yet tested. For now, it is probably your best bet to disable the allow list altogether. If your system administrator is unhappy with this, feel free to [drop a line in the devoted issue][3]
Explicitly allowing the RdPipe channel required by RDAccess is not yet tested. For now, it is probably your best bet to disable the allow list altogether. If your system administrator is unhappy with this, feel free to [drop a line in the devoted issue][3]

## Issues and contributing

Expand All @@ -117,6 +117,6 @@ published by the Free Software Foundation.

[1]: https://github.com/leonardder/
[2]: https://en.wikipedia.org/wiki/Jump_server
[3]: https://github.com/leonardder/nvdaRd/issues
[3]: https://github.com/leonardder/rdAccess/issues
[4]: https://github.com/leonardder/rd_pipe-rs
[5]: https://github.com/leonardder/rd_pipe-rs/blob/master/LICENSE

0 comments on commit 4ae14a4

Please sign in to comment.