From 945a3e2cd43c074ddf95ab7121ee7fa1879f50df Mon Sep 17 00:00:00 2001 From: ChucklesOnGitHub Date: Wed, 22 Jul 2026 16:50:52 +0100 Subject: [PATCH 1/2] fresh GUI admonition --- source/User-Manual/Installing-the-GUI.rst | 4 ++-- source/User-Manual/Plugins/index.rst | 3 +++ 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/source/User-Manual/Installing-the-GUI.rst b/source/User-Manual/Installing-the-GUI.rst index 0277f03..0b81a39 100644 --- a/source/User-Manual/Installing-the-GUI.rst +++ b/source/User-Manual/Installing-the-GUI.rst @@ -13,8 +13,6 @@ Windows Via installer (recommended) ---------------------------- -.. warning:: If you have previously installed version 1.x of the GUI and are an Open Ephys Acquisition Board user, you need to copy and paste the following into the File Explorer: :code:`%localappdata%\\Open Ephys\\shared-api10`, press enter to navigate to the folder, and delete the file :code:`libonidriver_ft600.dll`. Then, follow the instructions below to install the latest version of the GUI. - 1. Click the "Windows" link on `this page`_ to download the installer for the latest version of the GUI. 2. Double-click the downloaded executable to launch the installer. @@ -23,6 +21,8 @@ Via installer (recommended) 4. The GUI will be installed in :code:`C:\\Program Files\\Open Ephys\\open-ephys.exe`. +.. important:: Before installing any plugins in the Open Ephys GUI, start with a fresh session: open the GUI, go to :code:`Edit > Clear signal chain` and then close the GUI. Launch the GUI again and install any plugins you want to use, as described in the :ref:`Plugin Installer ` section. Restarting the GUI after emptying the signal chain ensures that no previously loaded plugins remain in memory, as some plugins may not work correctly if they are installed in a session that has already loaded plugins. + .. _windows-via-zip: Via .zip file diff --git a/source/User-Manual/Plugins/index.rst b/source/User-Manual/Plugins/index.rst index 0d2d3eb..1709aa0 100644 --- a/source/User-Manual/Plugins/index.rst +++ b/source/User-Manual/Plugins/index.rst @@ -67,12 +67,15 @@ When you drop a plugin onto the signal chain, you'll see an editor for any user- The blank region usually includes widgets for changing available settings. All plugins contain a "stream selector" containing information about all streams that pass through the plugin. For many plugins, the active parameters will only be applied to the currently selected stream. +.. _plugin_installer: Plugin Installer ################# The Plugin Installer is a simple graphical user interface that allows the user to download and install plugins that are not included by default. All available plugins are hosted in the `Open Ephys Plugins GitHub Account`_. All the plugins on here are either developed by the Open Ephys team or community-developed plugins that have been forked, polished, and released. +.. important:: Before installing any plugins in the Open Ephys GUI, start with a fresh session: open the GUI, go to :code:`Edit > Clear signal chain` and then close the GUI. Launch the GUI again and install any plugins you want to use, as described in the :ref:`Plugin Installer ` section. Restarting the GUI after emptying the signal chain ensures that no previously loaded plugins remain in memory, as some plugins may not work correctly if they are installed in a session that has already loaded plugins. + To open Plugin Installer, go to **File > Plugin Installer**, or press the shortcut keys Ctrl+P (⌘P on macOS). This brings up the interface below: .. image:: ../../_static/images/plugins/plugininstaller/plugininstaller.png From a03f7f546f2c20e65360dcd682811806754389b3 Mon Sep 17 00:00:00 2001 From: ChucklesOnGitHub Date: Wed, 22 Jul 2026 17:16:59 +0100 Subject: [PATCH 2/2] aacuevas edit --- source/User-Manual/Installing-the-GUI.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/source/User-Manual/Installing-the-GUI.rst b/source/User-Manual/Installing-the-GUI.rst index 0b81a39..8e4a7e2 100644 --- a/source/User-Manual/Installing-the-GUI.rst +++ b/source/User-Manual/Installing-the-GUI.rst @@ -21,7 +21,7 @@ Via installer (recommended) 4. The GUI will be installed in :code:`C:\\Program Files\\Open Ephys\\open-ephys.exe`. -.. important:: Before installing any plugins in the Open Ephys GUI, start with a fresh session: open the GUI, go to :code:`Edit > Clear signal chain` and then close the GUI. Launch the GUI again and install any plugins you want to use, as described in the :ref:`Plugin Installer ` section. Restarting the GUI after emptying the signal chain ensures that no previously loaded plugins remain in memory, as some plugins may not work correctly if they are installed in a session that has already loaded plugins. +.. important:: Before installing or updating any plugins in the Open Ephys GUI, start with a fresh session: open the GUI, go to :code:`Edit > Clear signal chain` and then close the GUI. Launch the GUI again and install any plugins you want to use, as described in the :ref:`Plugin Installer ` section. Restarting the GUI after emptying the signal chain ensures that no previously loaded plugins remain in memory, as some plugins may not work correctly if they are installed in a session that has already loaded plugins. .. _windows-via-zip: