brenekh / beryl

Simple timer with advanced features.

Beryl

Simple timer with advanced features.

Installation

Windows

Head over to the latest release and download the installer.

If you want to use a standalone executable, grab the standalone zip file and run beryl.exe.

Linux

Download the tarball from the latest release page and extract using tar -xf Beryl-<version>-Linux-amd64.tar.gz replacing <version> with the downloaded version.

Usage

Beryl uses profiles to define the different stages for the timer to run, as well as any plugins to use and their configurations. A sample profile is available in this repository.

More information on profile files, check out the wiki.

Plugin Development

Head over to the wiki to learn more about how to create plugins for Beryl.

License

Beryl is licensed under the standard MIT license, a copy of which can be found in the LICENSE file.

beryl's Issues

Add License

Windows Installer

Custom error dialogs for plugin errors

Instead of relying on uncaught exception dialogs, any errors stemming from a plugin should be caught and placed into a custom error dialog. This will help avoid issues where a plugin raises an error and the entire branch of execution no longer finishes.

Settings Dialog

Separate BrowserWindow for setting up stages, sounds, and plugins, which can later be exported to a file.

Allow .bipa files to be installed by passing them as a command-line argument

Installable Plugins

Plugins can be packaged into a Beryl Integration Plugin Archive file (.bipa) which can then be unpacked to a local data folder on the system for use by Beryl profiles. Once a plugin has been installed, it can be referenced by name in profiles instead of the direct file path.

Installed Plugins Location:

• Windows: $LOCALAPPDATA/Beryl/installedPlugins

• Linux and MacOS: $HOME/.beryl/installedPlugins

Do more with plugin versions

A profile should be able to request a specific plugin version as well as the latest version available (no version specified).

Plugins should also be stored as <plugin name>@<version> to facilitate this.

This could also help with #14

Show Confirmation That a Plugin Was Installed

Right now it's a bit ambiguous as to if a plugin was successfully installed.

However, iirc, displaying a message box is harder than an error box.

New plugin versions aren't installed unless the old folder is removed