Skip to content

live-keys/livekeys

Repository files navigation

Livekeys


Join the chat at https://gitter.im/live-keys/livekeys Build Status Build status

Livekeys is a platform that automates content creation in real time by combining visual scripting with live coding. Components are used to create pipelines for familiarized tasks (file reading, video editing, computer vision modules, etc), providing configuration via their user interfaces. To extend this pipeline, users can build their own components via live coding. Main features include:

  • Image and Video Processing: Load image/video files and applying various filters

  • Node Editor : Connect and configure components via nodes in a graph

  • Timeline Editor: Schedule animations and organize video segments

  • Code editor: Syntax highlighting, code completion, live coding, and seamless switching between UI configuration and code

  • Interactive learning module: Provides tutorials with interactions that guide you through the process of learning Livekeys.

  • Plugin support: Components are wrapped in plugins, then packages, which are installable through a package manager.

Installation and getting started

To get started, simply download the application from Livekeys's website, extract the archive, and you're ready to go. Step by step instructions are also found in the download section.

Compiling

To compile Livekeys, you need to have Qt and Open CV installed. You can then use qmake to generate the makefile, and run make or nmake to build:

cd <livekeys_path>/build
qmake -r ..
make (or nmake)

The executable and plugins will be found in the bin directory.

Contributing

There's an organization on github created for Livekeys plugins and projects, so anyone looking to contribute is always welcome. This section offers a quick overview on contributing, and there are simple quickstart issues available for anyone looking to start. Most of them deal with wrapping an Open CV functions and adding a sample. There are issues marked with easy which are similar, but may have a few more displayable parameters or require a bit more processing.

There's a chat room available on gitter and also a forum.

Changes

For changes and compatibility information between versions, see the CHANGELOG.

Roadmap

Livekeys's goal is to provide an environment where people can experiment with different libraries or algorithms and can also share their own as easily as possible. To do this, it needs to be scalable, plugin-based, have a simple and easy to use build system, and a place to access and share plugins. Our goal is to reach this in version 2.0 of the application.

  • Version 1.10 - MultiThreading Module
    • Async execution
  • Version 2.0 - Package Manager Details
    • Plugin and sample showroom on Live Keys's website
    • Support for fetching plugins and samples from within the application