Development

For the plugin development process, we recommend to run Neon Player from source.

Language

Neon Player is written in Python 3.12. At its core, Neon Player is built on top of the Neon Recording API and features a user interface based on PyQt.

Plugin API

Plugins are managed within the application's main process which communicates with plugins via callbacks (see below). These are defined in the root Plugin class. In order to create a new plugin, one has to inherit from this class and overwrite them as desired.

from pupil_labs.neon_player import Plugin

class MyCustomPlugin(Plugin):
    pass

Check out Neon Player's API documentation for more details on the available callbacks and how to use them.