Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions source/User-Manual/Installing-the-GUI.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand All @@ -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 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 <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
Expand Down
3 changes: 3 additions & 0 deletions source/User-Manual/Plugins/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <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
Expand Down
Loading